diff options
| author | 2025-02-18 19:41:52 +0000 | |
|---|---|---|
| committer | 2025-02-18 19:41:52 +0000 | |
| commit | bea01f55a87a9f5c523ed9419419187a70798cf4 (patch) | |
| tree | e8ce134198672dd0a22c3a07b6b2216919b7d0fd /v9.7.0/output | |
| parent | Deploying to docs from @ python-discord/bot-core@cbe2bae7bd4826c804fd690cc695... (diff) | |
Deploying to docs from @ python-discord/bot-core@16835478af6b842d776d634e53aab8ee31bd350c 🚀
Diffstat (limited to 'v9.7.0/output')
| -rw-r--r-- | v9.7.0/output/pydis_core.async_stats.html | 6 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.exts.html | 6 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.html | 10 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.site_api.html | 6 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.caching.html | 6 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.channel.html | 20 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.commands.html | 10 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.cooldown.html | 8 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.error_handling.html | 10 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.function.html | 6 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.html | 8 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.interactions.html | 14 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.logging.html | 6 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.members.html | 20 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.paste_service.html | 6 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.regex.html | 6 | ||||
| -rw-r--r-- | v9.7.0/output/pydis_core.utils.scheduling.html | 6 | 
17 files changed, 77 insertions, 77 deletions
diff --git a/v9.7.0/output/pydis_core.async_stats.html b/v9.7.0/output/pydis_core.async_stats.html index 906c845e..86d155f5 100644 --- a/v9.7.0/output/pydis_core.async_stats.html +++ b/v9.7.0/output/pydis_core.async_stats.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>async_stats - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> diff --git a/v9.7.0/output/pydis_core.exts.html b/v9.7.0/output/pydis_core.exts.html index 2db21f6e..73f7c23b 100644 --- a/v9.7.0/output/pydis_core.exts.html +++ b/v9.7.0/output/pydis_core.exts.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>Exts - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> diff --git a/v9.7.0/output/pydis_core.html b/v9.7.0/output/pydis_core.html index 4e6dac07..d6381b66 100644 --- a/v9.7.0/output/pydis_core.html +++ b/v9.7.0/output/pydis_core.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>Pydis Core - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -458,7 +458,7 @@  <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/c57fae8198cadcab3f9c0b09d1189d6b4eb9daf3/pydis_core/_bot.py#L35-L305"><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.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></p> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.6.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 method">  <dt class="sig sig-object py" id="pydis_core.BotBase.__init__"> @@ -591,7 +591,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e  To remove them, either remove the entire command or manually edit <cite>bot.all_commands</cite>.</p>  <dl class="field-list simple">  <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p>  </dd>  </dl>  </dd></dl> diff --git a/v9.7.0/output/pydis_core.site_api.html b/v9.7.0/output/pydis_core.site_api.html index 5af66945..a28aff9b 100644 --- a/v9.7.0/output/pydis_core.site_api.html +++ b/v9.7.0/output/pydis_core.site_api.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>site_api - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> diff --git a/v9.7.0/output/pydis_core.utils.caching.html b/v9.7.0/output/pydis_core.utils.caching.html index 1409a193..d30f6a07 100644 --- a/v9.7.0/output/pydis_core.utils.caching.html +++ b/v9.7.0/output/pydis_core.utils.caching.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>caching - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> diff --git a/v9.7.0/output/pydis_core.utils.channel.html b/v9.7.0/output/pydis_core.utils.channel.html index 64e5cdf9..8e6c997d 100644 --- a/v9.7.0/output/pydis_core.utils.channel.html +++ b/v9.7.0/output/pydis_core.utils.channel.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>channel - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -462,20 +462,20 @@  <dl class="field-list simple">  <dt class="field-odd">Parameters<span class="colon">:</span></dt>  <dd class="field-odd"><ul class="simple"> -<li><p><strong>bot</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></span>) – The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Bot</span></code></a> instance to use for getting/fetching.</p></li> +<li><p><strong>bot</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></span>) – The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Bot</span></code></a> instance to use for getting/fetching.</p></li>  <li><p><strong>channel_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The channel to get/fetch.</p></li>  </ul>  </dd>  <dt class="field-even">Raises<span class="colon">:</span></dt>  <dd class="field-even"><ul class="simple"> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.InvalidData" title="(in discord.py v2.5.0a)"><strong>discord.InvalidData</strong></a> – An unknown channel type was received from Discord.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.HTTPException" title="(in discord.py v2.5.0a)"><strong>discord.HTTPException</strong></a> – Retrieving the channel failed.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.NotFound" title="(in discord.py v2.5.0a)"><strong>discord.NotFound</strong></a> – Invalid Channel ID.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.5.0a)"><strong>discord.Forbidden</strong></a> – You do not have permission to fetch this channel.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.InvalidData" title="(in discord.py v2.6.0a)"><strong>discord.InvalidData</strong></a> – An unknown channel type was received from Discord.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.HTTPException" title="(in discord.py v2.6.0a)"><strong>discord.HTTPException</strong></a> – Retrieving the channel failed.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.NotFound" title="(in discord.py v2.6.0a)"><strong>discord.NotFound</strong></a> – Invalid Channel ID.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.6.0a)"><strong>discord.Forbidden</strong></a> – You do not have permission to fetch this channel.</p></li>  </ul>  </dd>  <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.GuildChannel" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuildChannel</span></code></a></span></p> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.GuildChannel" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuildChannel</span></code></a></span></p>  </dd>  <dt class="field-even">Returns<span class="colon">:</span></dt>  <dd class="field-even"><p>The channel from the ID.</p> @@ -490,7 +490,7 @@  <dl class="field-list simple">  <dt class="field-odd">Parameters<span class="colon">:</span></dt>  <dd class="field-odd"><ul class="simple"> -<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.TextChannel" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code></a></span>) – The channel to check.</p></li> +<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.TextChannel" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code></a></span>) – The channel to check.</p></li>  <li><p><strong>category_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The category to check for.</p></li>  </ul>  </dd> diff --git a/v9.7.0/output/pydis_core.utils.commands.html b/v9.7.0/output/pydis_core.utils.commands.html index b2579385..d3189f71 100644 --- a/v9.7.0/output/pydis_core.utils.commands.html +++ b/v9.7.0/output/pydis_core.utils.commands.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>commands - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -461,12 +461,12 @@  <dl class="field-list simple">  <dt class="field-odd">Parameters<span class="colon">:</span></dt>  <dd class="field-odd"><ul class="simple"> -<li><p><strong>ctx</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Context</span></code></a></span>) – The command’s context</p></li> +<li><p><strong>ctx</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Context</span></code></a></span>) – The command’s context</p></li>  <li><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The provided text argument of the command (if given)</p></li>  </ul>  </dd>  <dt class="field-even">Raises<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.BadArgument" title="(in discord.py v2.5.0a)"><strong>discord.ext.commands.BadArgument</strong></a> – <cite>text</cite> wasn’t provided and there’s no reply message / reply message content.</p> +<dd class="field-even"><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.BadArgument" title="(in discord.py v2.6.0a)"><strong>discord.ext.commands.BadArgument</strong></a> – <cite>text</cite> wasn’t provided and there’s no reply message / reply message content.</p>  </dd>  <dt class="field-odd">Return type<span class="colon">:</span></dt>  <dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></p> diff --git a/v9.7.0/output/pydis_core.utils.cooldown.html b/v9.7.0/output/pydis_core.utils.cooldown.html index bce095f0..11eaeed5 100644 --- a/v9.7.0/output/pydis_core.utils.cooldown.html +++ b/v9.7.0/output/pydis_core.utils.cooldown.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>cooldown - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -458,7 +458,7 @@  <dl class="py exception">  <dt class="sig sig-object py" id="pydis_core.utils.cooldown.CommandOnCooldown">  <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CommandOnCooldown</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c57fae8198cadcab3f9c0b09d1189d6b4eb9daf3/pydis_core/utils/cooldown.py#L38-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown" title="Link to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.CommandError" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommandError</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Generic" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Generic</span></code></a>[<a class="reference internal" href="#pydis_core.utils.cooldown.P" title="pydis_core.utils.cooldown.P"><code class="xref py py-obj docutils literal notranslate"><span class="pre">P</span></code></a>, <a class="reference internal" href="#pydis_core.utils.cooldown.R" title="pydis_core.utils.cooldown.R"><code class="xref py py-obj docutils literal notranslate"><span class="pre">R</span></code></a>]</p> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.CommandError" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommandError</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Generic" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Generic</span></code></a>[<a class="reference internal" href="#pydis_core.utils.cooldown.P" title="pydis_core.utils.cooldown.P"><code class="xref py py-obj docutils literal notranslate"><span class="pre">P</span></code></a>, <a class="reference internal" href="#pydis_core.utils.cooldown.R" title="pydis_core.utils.cooldown.R"><code class="xref py py-obj docutils literal notranslate"><span class="pre">R</span></code></a>]</p>  <p>Raised when a command is invoked while on cooldown.</p>  <dl class="py method">  <dt class="sig sig-object py" id="pydis_core.utils.cooldown.CommandOnCooldown.__init__"> diff --git a/v9.7.0/output/pydis_core.utils.error_handling.html b/v9.7.0/output/pydis_core.utils.error_handling.html index fe42c593..389d6559 100644 --- a/v9.7.0/output/pydis_core.utils.error_handling.html +++ b/v9.7.0/output/pydis_core.utils.error_handling.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>error_handling - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -461,8 +461,8 @@  <dl class="field-list simple">  <dt class="field-odd">Parameters<span class="colon">:</span></dt>  <dd class="field-odd"><ul class="simple"> -<li><p><strong>error</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Forbidden</span></code></a></span>) – The raised <code class="docutils literal notranslate"><span class="pre">discord.Forbidden</span></code> to check.</p></li> -<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The message to reply to and include in logs, if error is 90001 and message is provided.</p></li> +<li><p><strong>error</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Forbidden</span></code></a></span>) – The raised <code class="docutils literal notranslate"><span class="pre">discord.Forbidden</span></code> to check.</p></li> +<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The message to reply to and include in logs, if error is 90001 and message is provided.</p></li>  </ul>  </dd>  <dt class="field-even">Return type<span class="colon">:</span></dt> diff --git a/v9.7.0/output/pydis_core.utils.function.html b/v9.7.0/output/pydis_core.utils.function.html index b9e1d27f..dc180eb1 100644 --- a/v9.7.0/output/pydis_core.utils.function.html +++ b/v9.7.0/output/pydis_core.utils.function.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>function - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> diff --git a/v9.7.0/output/pydis_core.utils.html b/v9.7.0/output/pydis_core.utils.html index 49be1920..a9a2e202 100644 --- a/v9.7.0/output/pydis_core.utils.html +++ b/v9.7.0/output/pydis_core.utils.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>Utils - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -465,7 +465,7 @@  </dd>  </dl>  <dl> -<dt>Patches <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Command</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Group" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Group</span></code></a> to support root aliases.</dt><dd><p>A <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code> keyword argument is added to these two objects, which is a sequence of alias names +<dt>Patches <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Command</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Group" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Group</span></code></a> to support root aliases.</dt><dd><p>A <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code> keyword argument is added to these two objects, which is a sequence of alias names  that will act as top-level groups rather than being aliases of the command’s group.</p>  <p>It’s stored as an attribute also named <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code></p>  </dd> diff --git a/v9.7.0/output/pydis_core.utils.interactions.html b/v9.7.0/output/pydis_core.utils.interactions.html index 87a840ea..b10b01e9 100644 --- a/v9.7.0/output/pydis_core.utils.interactions.html +++ b/v9.7.0/output/pydis_core.utils.interactions.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>interactions - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -457,7 +457,7 @@  <dl class="py class">  <dt class="sig sig-object py" id="pydis_core.utils.interactions.DeleteMessageButton">  <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DeleteMessageButton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('secondary',</span> <span class="pre">2)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Delete'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c57fae8198cadcab3f9c0b09d1189d6b4eb9daf3/pydis_core/utils/interactions.py#L89-L115"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton" title="Link to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.Button" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Button</span></code></a></p> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.Button" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Button</span></code></a></p>  <p>A button that can be added to a view to delete the message containing the view on click.</p>  <p>This button itself carries out no interaction checks, these should be done by the parent view.</p>  <p>See <a class="reference internal" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck" title="pydis_core.utils.interactions.ViewWithUserAndRoleCheck"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.utils.interactions.ViewWithUserAndRoleCheck</span></code></a> for a view that implements basic checks.</p> @@ -490,7 +490,7 @@  <dl class="py class">  <dt class="sig sig-object py" id="pydis_core.utils.interactions.ViewWithUserAndRoleCheck">  <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ViewWithUserAndRoleCheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c57fae8198cadcab3f9c0b09d1189d6b4eb9daf3/pydis_core/utils/interactions.py#L29-L87"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck" title="Link to this definition">¶</a></dt> -<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.View" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">View</span></code></a></p> +<dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.View" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">View</span></code></a></p>  <p>A view that allows the original invoker and moderators to interact with it.</p>  <dl class="field-list simple">  <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -499,7 +499,7 @@  <li><p><strong>allowed_roles</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of role ids that are allowed to interact with the view.</p></li>  <li><p><strong>timeout</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – Timeout in seconds from last interaction with the UI before no longer accepting input.  If <code class="docutils literal notranslate"><span class="pre">None</span></code> then there is no timeout.</p></li> -<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The message to remove the view from on timeout. This can also be set with +<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The message to remove the view from on timeout. This can also be set with  <code class="docutils literal notranslate"><span class="pre">view.message</span> <span class="pre">=</span> <span class="pre">await</span> <span class="pre">ctx.send(</span> <span class="pre">...</span> <span class="pre">)`</span></code> , or similar, after the view is instantiated.</p></li>  </ul>  </dd> @@ -515,7 +515,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod  <dd><p>Ensure the user clicking the button is the view invoker, or a moderator.</p>  <dl class="field-list simple">  <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>interaction</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.Interaction" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interaction</span></code></a></span>) – The interaction that occurred.</p> +<dd class="field-odd"><p><strong>interaction</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.Interaction" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interaction</span></code></a></span>) – The interaction that occurred.</p>  </dd>  <dt class="field-even">Return type<span class="colon">:</span></dt>  <dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> diff --git a/v9.7.0/output/pydis_core.utils.logging.html b/v9.7.0/output/pydis_core.utils.logging.html index 64406dbd..c9fc68e8 100644 --- a/v9.7.0/output/pydis_core.utils.logging.html +++ b/v9.7.0/output/pydis_core.utils.logging.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>logging - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> diff --git a/v9.7.0/output/pydis_core.utils.members.html b/v9.7.0/output/pydis_core.utils.members.html index 95d85c91..d1f91395 100644 --- a/v9.7.0/output/pydis_core.utils.members.html +++ b/v9.7.0/output/pydis_core.utils.members.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>members - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> @@ -454,17 +454,17 @@          <article role="main" id="furo-main-content">            <section id="module-pydis_core.utils.members">  <span id="members"></span><h1>members<a class="headerlink" href="#module-pydis_core.utils.members" title="Link to this heading">¶</a></h1> -<p>Useful helper functions for interactin with <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> objects.</p> +<p>Useful helper functions for interactin with <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> objects.</p>  <dl class="py function">  <dt class="sig sig-object py" id="pydis_core.utils.members.get_or_fetch_member">  <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_member</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c57fae8198cadcab3f9c0b09d1189d6b4eb9daf3/pydis_core/utils/members.py#L12-L31"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.members.get_or_fetch_member" title="Link to this definition">¶</a></dt>  <dd><p>Attempt to get a member from cache; on failure fetch from the API.</p>  <dl class="field-list simple">  <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p>  </dd>  <dt class="field-even">Returns<span class="colon">:</span></dt> -<dd class="field-even"><p>The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a> to indicate the member could not be found.</p> +<dd class="field-even"><p>The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a> to indicate the member could not be found.</p>  </dd>  </dl>  </dd></dl> @@ -474,13 +474,13 @@  <em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_role_change</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c57fae8198cadcab3f9c0b09d1189d6b4eb9daf3/pydis_core/utils/members.py#L33-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.members.handle_role_change" title="Link to this definition">¶</a></dt>  <dd><p>Await the given <code class="docutils literal notranslate"><span class="pre">coro</span></code> with <code class="docutils literal notranslate"><span class="pre">role</span></code> as the sole argument.</p>  <p>Handle errors that we expect to be raised from -<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p> +<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p>  <dl class="field-list simple">  <dt class="field-odd">Parameters<span class="colon">:</span></dt>  <dd class="field-odd"><ul class="simple"> -<li><p><strong>member</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a></span>) – The member that is being modified for logging purposes.</p></li> -<li><p><strong>coro</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>]</span>) – This is intended to be <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> or <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p></li> -<li><p><strong>role</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a></span>) – The role to be passed to <code class="docutils literal notranslate"><span class="pre">coro</span></code>.</p></li> +<li><p><strong>member</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a></span>) – The member that is being modified for logging purposes.</p></li> +<li><p><strong>coro</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>]</span>) – This is intended to be <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> or <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p></li> +<li><p><strong>role</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a></span>) – The role to be passed to <code class="docutils literal notranslate"><span class="pre">coro</span></code>.</p></li>  </ul>  </dd>  <dt class="field-even">Return type<span class="colon">:</span></dt> diff --git a/v9.7.0/output/pydis_core.utils.paste_service.html b/v9.7.0/output/pydis_core.utils.paste_service.html index 8f55fca5..adacfa03 100644 --- a/v9.7.0/output/pydis_core.utils.paste_service.html +++ b/v9.7.0/output/pydis_core.utils.paste_service.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>paste_service - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> diff --git a/v9.7.0/output/pydis_core.utils.regex.html b/v9.7.0/output/pydis_core.utils.regex.html index e3410799..55d4f166 100644 --- a/v9.7.0/output/pydis_core.utils.regex.html +++ b/v9.7.0/output/pydis_core.utils.regex.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>regex - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> diff --git a/v9.7.0/output/pydis_core.utils.scheduling.html b/v9.7.0/output/pydis_core.utils.scheduling.html index 54595f83..7ea452d9 100644 --- a/v9.7.0/output/pydis_core.utils.scheduling.html +++ b/v9.7.0/output/pydis_core.utils.scheduling.html @@ -7,12 +7,12 @@      <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->          <title>scheduling - Pydis Core v9.7.0</title> -      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />      <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> -    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> -    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" />      <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" />  |