diff options
Diffstat (limited to 'main/output/pydis_core.html')
-rw-r--r-- | main/output/pydis_core.html | 72 |
1 files changed, 38 insertions, 34 deletions
diff --git a/main/output/pydis_core.html b/main/output/pydis_core.html index 0c4debca..10eafcef 100644 --- a/main/output/pydis_core.html +++ b/main/output/pydis_core.html @@ -331,6 +331,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.8.0/output/pydis_core.html">v11.8.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.7.0/output/pydis_core.html">v11.7.0</a> </li> @@ -480,12 +484,12 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.BotBase"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">BotBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">BotBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.7.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></p> <p>A sub-class that implements many common features that Python Discord bots use.</p> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.guild_id"> -<span class="sig-name descname"><span class="pre">guild_id</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.guild_id" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">guild_id</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.guild_id" title="Link to this definition">¶</a></dt> <dd><p>ID of the guild that the bot belongs to.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -496,7 +500,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.http_session"> -<span class="sig-name descname"><span class="pre">http_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.http_session" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">http_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.http_session" title="Link to this definition">¶</a></dt> <dd><p>The http session used for sending out HTTP requests.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -507,7 +511,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.api_client"> -<span class="sig-name descname"><span class="pre">api_client</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.api_client" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">api_client</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.api_client" title="Link to this definition">¶</a></dt> <dd><p>The API client used for communications with the site service.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -518,7 +522,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.statsd_url"> -<span class="sig-name descname"><span class="pre">statsd_url</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.statsd_url" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">statsd_url</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.statsd_url" title="Link to this definition">¶</a></dt> <dd><p>The url that statsd sends metrics to.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -529,7 +533,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.redis_session"> -<span class="sig-name descname"><span class="pre">redis_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.redis_session" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">redis_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.redis_session" title="Link to this definition">¶</a></dt> <dd><p>The redis session used to communicate with the Redis instance.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -540,7 +544,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.stats"> -<span class="sig-name descname"><span class="pre">stats</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.stats" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">stats</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.stats" title="Link to this definition">¶</a></dt> <dd><p>The statsd client that sends metrics.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -551,7 +555,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.all_extensions"> -<span class="sig-name descname"><span class="pre">all_extensions</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.all_extensions" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">all_extensions</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.all_extensions" title="Link to this definition">¶</a></dt> <dd><p>All extensions that were found within the <code class="docutils literal notranslate"><span class="pre">module</span></code> passed to <code class="docutils literal notranslate"><span class="pre">self.load_extensions</span></code>. Use <code class="docutils literal notranslate"><span class="pre">self.extensions</span></code> to get the loaded extensions.</p> <dl class="field-list simple"> @@ -563,7 +567,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L70-L123"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.__init__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L70-L123"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.__init__" title="Link to this definition">¶</a></dt> <dd><p>Initialise the base bot instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -582,7 +586,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.add_cog"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_cog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cog</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L212-L216"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_cog" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_cog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cog</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L212-L216"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_cog" title="Link to this definition">¶</a></dt> <dd><p>Add the given <code class="docutils literal notranslate"><span class="pre">cog</span></code> to the bot and log the operation.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -593,7 +597,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.add_command"> -<span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L217-L221"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_command" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L217-L221"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_command" title="Link to this definition">¶</a></dt> <dd><p>Add <code class="docutils literal notranslate"><span class="pre">command</span></code> as normal and then add its root aliases to the bot.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -604,7 +608,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.clear"> -<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L237-L240"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.clear" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L237-L240"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.clear" title="Link to this definition">¶</a></dt> <dd><p>Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -615,7 +619,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L326-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.close" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L326-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.close" title="Link to this definition">¶</a></dt> <dd><p>Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -626,7 +630,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.load_extensions"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_extensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sync_app_commands</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L180-L190"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.load_extensions" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_extensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sync_app_commands</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L180-L190"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.load_extensions" title="Link to this definition">¶</a></dt> <dd><p>Load all the extensions within the given <code class="docutils literal notranslate"><span class="pre">module</span></code> and save them to <code class="docutils literal notranslate"><span class="pre">self.all_extensions</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -640,7 +644,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.log_to_dev_log"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">log_to_dev_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L265-L267"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.log_to_dev_log" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">log_to_dev_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L265-L267"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.log_to_dev_log" title="Link to this definition">¶</a></dt> <dd><p>Log the given message to #dev-log.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -651,7 +655,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.on_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L248-L264"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_available" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L248-L264"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_available" title="Link to this definition">¶</a></dt> <dd><p>Set the internal guild available event when self.guild_id becomes available.</p> <p>If the cache appears to still be empty (no members, no channels, or no roles), the event will not be set and <cite>guild_available_but_cache_empty</cite> event will be emitted.</p> @@ -664,7 +668,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.on_guild_unavailable"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L241-L247"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_unavailable" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L241-L247"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_unavailable" title="Link to this definition">¶</a></dt> <dd><p>Clear the internal guild available event when self.guild_id becomes unavailable.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -675,7 +679,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.ping_services"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ping_services</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L323-L325"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.ping_services" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ping_services</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L323-L325"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.ping_services" title="Link to this definition">¶</a></dt> <dd><p>Ping all required services on setup to ensure they are up before starting.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -686,7 +690,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.process_commands"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_commands</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L277-L286"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.process_commands" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_commands</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L277-L286"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.process_commands" title="Link to this definition">¶</a></dt> <dd><p>Overwrite default Discord.py behaviour to process commands only after ensuring extensions are loaded.</p> <p>This extension check is only relevant for clients that make use of <a class="reference internal" href="#pydis_core.BotBase.load_extensions" title="pydis_core.BotBase.load_extensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.BotBase.load_extensions</span></code></a>.</p> <dl class="field-list simple"> @@ -698,7 +702,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.register_command_error_manager"> -<span class="sig-name descname"><span class="pre">register_command_error_manager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manager</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L124-L133"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.register_command_error_manager" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">register_command_error_manager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manager</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L124-L133"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.register_command_error_manager" title="Link to this definition">¶</a></dt> <dd><p>Bind an instance of the command error manager to both the bot and the command tree.</p> <p>The reason this doesn’t happen in the constructor is because error handlers might need an instance of the bot. So registration needs to happen once the bot instance has been created.</p> @@ -711,7 +715,7 @@ So registration needs to happen once the bot instance has been created.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.remove_command"> -<span class="sig-name descname"><span class="pre">remove_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L222-L236"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.remove_command" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">remove_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L222-L236"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.remove_command" title="Link to this definition">¶</a></dt> <dd><p>Remove a command/alias as normal and then remove its root aliases from the bot.</p> <p>Individual root aliases cannot be removed by this function. To remove them, either remove the entire command or manually edit <cite>bot.all_commands</cite>.</p> @@ -724,7 +728,7 @@ To remove them, either remove the entire command or manually edit <cite>bot.all_ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.setup_hook"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_hook</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L287-L322"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.setup_hook" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_hook</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L287-L322"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.setup_hook" title="Link to this definition">¶</a></dt> <dd><p>An async init to startup generic services.</p> <p>Connects to statsd, and calls <a class="reference internal" href="pydis_core.async_stats.html#pydis_core.async_stats.AsyncStatsClient.create_socket" title="pydis_core.async_stats.AsyncStatsClient.create_socket"><code class="xref py py-func docutils literal notranslate"><span class="pre">AsyncStatsClient.create_socket</span></code></a> @@ -738,7 +742,7 @@ and <a class="reference internal" href="#pydis_core.BotBase.ping_services" title <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.wait_until_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait_until_guild_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L268-L276"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.wait_until_guild_available" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait_until_guild_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L268-L276"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.wait_until_guild_available" title="Link to this definition">¶</a></dt> <dd><p>Wait until the guild that matches the <code class="docutils literal notranslate"><span class="pre">guild_id</span></code> given at init is available (and the cache is ready).</p> <p>The on_ready event is inadequate because it only waits 2 seconds for a GUILD_CREATE gateway event before giving up and thus not populating the cache for unavailable guilds.</p> @@ -753,14 +757,14 @@ gateway event before giving up and thus not populating the cache for unavailable <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.EmptyPaginatorEmbedError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.EmptyPaginatorEmbedError" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.EmptyPaginatorEmbedError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when attempting to paginate with empty contents.</p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.LinePaginator"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Paginator" title="(in discord.py v2.7.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"> @@ -777,14 +781,14 @@ gateway event before giving up and thus not populating the cache for unavailable </dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.LinePaginator.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.__init__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.__init__" title="Link to this definition">¶</a></dt> <dd><p>This function overrides the Paginator.__init__ from inside discord.ext.commands.</p> <p>It overrides in order to allow us to configure the maximum number of lines per page.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.LinePaginator.add_line"> -<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.add_line" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.add_line" title="Link to this definition">¶</a></dt> <dd><p>Adds a line to the current page.</p> <p>If a line on a page exceeds <cite>max_size</cite> characters, then <cite>max_size</cite> will go up to <cite>scale_to_size</cite> for a single line before creating a new page for the overflow words. If it @@ -812,7 +816,7 @@ page at a reasonable size.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.LinePaginator.paginate"> -<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restrict_to_user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exception_on_empty_embed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.paginate" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restrict_to_user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exception_on_empty_embed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.paginate" title="Link to this definition">¶</a></dt> <dd><p>Use a paginator and set of reactions to provide pagination over a set of lines.</p> <p>The reactions are used to switch page, or to finish with pagination.</p> <p>When used, this will send a message using <cite>ctx.send()</cite> and apply a set of reactions to it. These reactions may @@ -856,7 +860,7 @@ to any user with a moderation role.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.PaginationEmojis"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PaginationEmojis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.PaginationEmojis" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PaginationEmojis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.PaginationEmojis" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel" title="(in Pydantic Validation 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"> @@ -885,7 +889,7 @@ to any user with a moderation role.</p> <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_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:94652709835776',</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> +<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:94895199657824',</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> @@ -948,13 +952,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">0x000056160d259400,</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">"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">0x00007f9205f7c3b0,</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">0x00007f9201064670,</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">0x00007f9205fccef0,</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">0x00007f92010646c0,</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">0x00007f9205feb4b0,</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">0x00007f9201064620,</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">0x00007f9206308eb0,</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">0x00007f9201064710,</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">0x00007f9205f7c3f0,</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">0x00007f92010645d0,</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">0x0000564e82aa9f60,</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">0x00007f0c639eb4b0,</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">0x00007f0c5f89cb20,</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">0x00007f0c639ccef0,</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">0x00007f0c5f89cbc0,</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">0x00007f0c6397c3f0,</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">0x00007f0c5f89cad0,</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">0x00007f0c63c78eb0,</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">0x00007f0c5f89cc10,</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">0x00007f0c6397c3b0,</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">0x00007f0c5f89cb70,</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">0x00007f92018c20f0,</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">0x00007f920197e7f0,</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">0x00007f9205feb4b0,</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">0x00007f9201064620,</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">0x00007f9201af0cf0,</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">0x00007f9201750b30,</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">0x00007f92016ff630,</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">0x00007f9205f7c3f0,</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">0x00007f92010645d0,</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">0x00007f9201af0cf0,</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">0x00007f9200c72e30,</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">0x00007f9200c735f0,</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">0x00007f9205f7c3b0,</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">0x00007f9201064670,</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">0x00007f9201af0cf0,</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">0x00007f9200c73c70,</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">0x00007f9200c732f0,</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">0x00007f9205fccef0,</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">0x00007f92010646c0,</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">0x00007f9201af0cf0,</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">0x00007f9200c71f30,</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">0x00007f9200c71d70,</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">0x00007f9206308eb0,</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">0x00007f9201064710,</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">0x00007f9201af0cf0,</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">0x000056160d259400,</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">0x00007f9201af0cf0,</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">0x00007f0c6056d2f0,</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">0x00007f0c5f4f81b0,</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">0x00007f0c639eb4b0,</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">0x00007f0c5f89cb20,</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">0x00007f0c602a0cf0,</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">0x00007f0c4ee342b0,</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">0x00007f0c60108130,</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">0x00007f0c6397c3f0,</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">0x00007f0c5f89cad0,</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">0x00007f0c602a0cf0,</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">0x00007f0c601081f0,</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">0x00007f0c60108670,</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">0x00007f0c6397c3b0,</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">0x00007f0c5f89cb70,</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">0x00007f0c602a0cf0,</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">0x00007f0c4ef34270,</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">0x00007f0c4ee2eab0,</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">0x00007f0c639ccef0,</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">0x00007f0c5f89cbc0,</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">0x00007f0c602a0cf0,</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">0x00007f0c4ee2f4b0,</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">0x00007f0c4ee2eb70,</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">0x00007f0c63c78eb0,</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">0x00007f0c5f89cc10,</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">0x00007f0c602a0cf0,</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">0x0000564e82aa9f60,</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">0x00007f0c602a0cf0,</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> @@ -974,12 +978,12 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <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/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L29-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError" title="Link to this definition">¶</a></dt> +<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/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L29-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.14)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Exception class for startup errors.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.StartupError.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9f0162c0869ee8e0ae158636c8f0eac96159a675/pydis_core/_bot.py#L32-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError.__init__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/74072b3709d87dc811a4972aec1ef172101e49bf/pydis_core/_bot.py#L32-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError.__init__" title="Link to this definition">¶</a></dt> <dd></dd></dl> </dd></dl> |