diff options
183 files changed, 76 insertions, 76 deletions
diff --git a/main/.buildinfo b/main/.buildinfo index 0ba4cc3e..011be8ac 100644 --- a/main/.buildinfo +++ b/main/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 174db63fddab9c6227f17f77fe24c0b9 +config: 2d2e5e5abdc7a91d349d32602c3c2f96 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/changelog.doctree b/main/.doctrees/changelog.doctree Binary files differindex 51ac0431..593ce9b2 100644 --- a/main/.doctrees/changelog.doctree +++ b/main/.doctrees/changelog.doctree diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle Binary files differindex 58a9ee20..189135cc 100644 --- a/main/.doctrees/environment.pickle +++ b/main/.doctrees/environment.pickle diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree Binary files differindex 2ddcb132..778f4bd1 100644 --- a/main/.doctrees/index.doctree +++ b/main/.doctrees/index.doctree diff --git a/main/.doctrees/output/botcore.async_stats.doctree b/main/.doctrees/output/botcore.async_stats.doctree Binary files differindex cda64ecd..458afb11 100644 --- a/main/.doctrees/output/botcore.async_stats.doctree +++ b/main/.doctrees/output/botcore.async_stats.doctree diff --git a/main/.doctrees/output/botcore.doctree b/main/.doctrees/output/botcore.doctree Binary files differindex d401fbae..1542e409 100644 --- a/main/.doctrees/output/botcore.doctree +++ b/main/.doctrees/output/botcore.doctree diff --git a/main/.doctrees/output/botcore.exts.doctree b/main/.doctrees/output/botcore.exts.doctree Binary files differindex d50c344b..0a3d89dc 100644 --- a/main/.doctrees/output/botcore.exts.doctree +++ b/main/.doctrees/output/botcore.exts.doctree diff --git a/main/.doctrees/output/botcore.site_api.doctree b/main/.doctrees/output/botcore.site_api.doctree Binary files differindex 3f9d015f..676a94d4 100644 --- a/main/.doctrees/output/botcore.site_api.doctree +++ b/main/.doctrees/output/botcore.site_api.doctree diff --git a/main/.doctrees/output/botcore.utils.caching.doctree b/main/.doctrees/output/botcore.utils.caching.doctree Binary files differindex da1f4c73..e8c1d522 100644 --- a/main/.doctrees/output/botcore.utils.caching.doctree +++ b/main/.doctrees/output/botcore.utils.caching.doctree diff --git a/main/.doctrees/output/botcore.utils.channel.doctree b/main/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 01efe1e4..9a3c8ba7 100644 --- a/main/.doctrees/output/botcore.utils.channel.doctree +++ b/main/.doctrees/output/botcore.utils.channel.doctree diff --git a/main/.doctrees/output/botcore.utils.commands.doctree b/main/.doctrees/output/botcore.utils.commands.doctree Binary files differindex a1575e68..403c3094 100644 --- a/main/.doctrees/output/botcore.utils.commands.doctree +++ b/main/.doctrees/output/botcore.utils.commands.doctree diff --git a/main/.doctrees/output/botcore.utils.doctree b/main/.doctrees/output/botcore.utils.doctree Binary files differindex c505792f..82f5f627 100644 --- a/main/.doctrees/output/botcore.utils.doctree +++ b/main/.doctrees/output/botcore.utils.doctree diff --git a/main/.doctrees/output/botcore.utils.interactions.doctree b/main/.doctrees/output/botcore.utils.interactions.doctree Binary files differindex 4b276c8d..5cbe8c1f 100644 --- a/main/.doctrees/output/botcore.utils.interactions.doctree +++ b/main/.doctrees/output/botcore.utils.interactions.doctree diff --git a/main/.doctrees/output/botcore.utils.logging.doctree b/main/.doctrees/output/botcore.utils.logging.doctree Binary files differindex d725fa6a..6a570dce 100644 --- a/main/.doctrees/output/botcore.utils.logging.doctree +++ b/main/.doctrees/output/botcore.utils.logging.doctree diff --git a/main/.doctrees/output/botcore.utils.members.doctree b/main/.doctrees/output/botcore.utils.members.doctree Binary files differindex ef46d822..2736c478 100644 --- a/main/.doctrees/output/botcore.utils.members.doctree +++ b/main/.doctrees/output/botcore.utils.members.doctree diff --git a/main/.doctrees/output/botcore.utils.regex.doctree b/main/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 1f30a43b..f29af8f6 100644 --- a/main/.doctrees/output/botcore.utils.regex.doctree +++ b/main/.doctrees/output/botcore.utils.regex.doctree diff --git a/main/.doctrees/output/botcore.utils.scheduling.doctree b/main/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex c4929ca1..18a49a22 100644 --- a/main/.doctrees/output/botcore.utils.scheduling.doctree +++ b/main/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/main/output/botcore.async_stats.html b/main/output/botcore.async_stats.html index efcd9b18..faf8cfa7 100644 --- a/main/output/botcore.async_stats.html +++ b/main/output/botcore.async_stats.html @@ -305,12 +305,12 @@ <p>An async transport method for statsd communication.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncStatsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/async_stats.py#L12-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncStatsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/async_stats.py#L12-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatsClientBase</span></code></a></p> <p>An async implementation of <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statsd.client.base.StatsClientBase</span></code></a> that supports async stat communication.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/async_stats.py#L15-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/async_stats.py#L15-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Create a new <a class="reference internal" href="#botcore.async_stats.AsyncStatsClient" title="botcore.async_stats.AsyncStatsClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncStatsClient</span></code></a>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -327,7 +327,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient.create_socket"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_socket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/async_stats.py#L40-L47"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.create_socket" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_socket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/async_stats.py#L40-L47"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.create_socket" title="Permalink to this definition">#</a></dt> <dd><p>Use <a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code></a> from the loop given on init to create a socket.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> diff --git a/main/output/botcore.html b/main/output/botcore.html index 0f24102d..67f852b4 100644 --- a/main/output/botcore.html +++ b/main/output/botcore.html @@ -305,12 +305,12 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L36-L292"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L36-L292"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase" title="Permalink 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.0.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="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L39-L89"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.__init__" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L39-L89"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.__init__" title="Permalink 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> @@ -329,7 +329,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L152-L156"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_cog" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L152-L156"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_cog" title="Permalink 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> @@ -340,7 +340,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L157-L161"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_command" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L157-L161"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_command" title="Permalink 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> @@ -351,7 +351,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L177-L180"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.clear" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L177-L180"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.clear" title="Permalink 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> @@ -362,7 +362,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L258-L292"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.close" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L258-L292"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.close" title="Permalink 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> @@ -373,7 +373,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.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><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L119-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.load_extensions" title="Permalink 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><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L119-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.load_extensions" title="Permalink to this definition">#</a></dt> <dd><p>Load all the extensions within the given module and save them to <code class="docutils literal notranslate"><span class="pre">self.all_extensions</span></code>.</p> <p>This should be ran in a task on the event loop to avoid deadlocks caused by <code class="docutils literal notranslate"><span class="pre">wait_for</span></code> calls.</p> <dl class="field-list simple"> @@ -385,7 +385,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L205-L208"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.log_to_dev_log" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L205-L208"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.log_to_dev_log" title="Permalink 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> @@ -396,7 +396,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L188-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_available" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L188-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_available" title="Permalink 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> @@ -409,7 +409,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="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L181-L187"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_unavailable" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L181-L187"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_unavailable" title="Permalink 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> @@ -420,7 +420,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="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L254-L257"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.ping_services" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L254-L257"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.ping_services" title="Permalink 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> @@ -431,7 +431,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="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L162-L176"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.remove_command" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L162-L176"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.remove_command" title="Permalink 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> @@ -444,7 +444,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="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L218-L253"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.setup_hook" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L218-L253"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.setup_hook" title="Permalink 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="botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.create_socket" title="botcore.async_stats.AsyncStatsClient.create_socket"><code class="xref py py-func docutils literal notranslate"><span class="pre">AsyncStatsClient.create_socket</span></code></a> @@ -458,7 +458,7 @@ and <a class="reference internal" href="#botcore.BotBase.ping_services" title="b <dl class="py method"> <dt class="sig sig-object py" id="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L209-L217"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.wait_until_guild_available" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L209-L217"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.wait_until_guild_available" title="Permalink 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> @@ -473,12 +473,12 @@ gateway event before giving up and thus not populating the cache for unavailable <dl class="py exception"> <dt class="sig sig-object py" id="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L28-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L28-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError" title="Permalink 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.10)"><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="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/_bot.py#L31-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError.__init__" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/_bot.py#L31-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError.__init__" title="Permalink to this definition">#</a></dt> <dd></dd></dl> </dd></dl> diff --git a/main/output/botcore.site_api.html b/main/output/botcore.site_api.html index 5e69a242..5c367ffe 100644 --- a/main/output/botcore.site_api.html +++ b/main/output/botcore.site_api.html @@ -305,12 +305,12 @@ <p>An API wrapper around the Site API.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.site_api.APIClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L42-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L42-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>A wrapper for the Django Site API.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L48-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L48-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">APIClient</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -325,7 +325,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L75-L78"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.close" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L75-L78"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.close" title="Permalink to this definition">#</a></dt> <dd><p>Close the aiohttp session.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -336,7 +336,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.delete"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L137-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.delete" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L137-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.delete" title="Permalink to this definition">#</a></dt> <dd><p>Send a DELETE request to the site API and return the JSON response.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -357,7 +357,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.get"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L121-L124"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.get" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L121-L124"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.get" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with GET passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -368,7 +368,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.maybe_raise_for_status"> -<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maybe_raise_for_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">should_raise</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L79-L99"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.maybe_raise_for_status" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maybe_raise_for_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">should_raise</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L79-L99"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.maybe_raise_for_status" title="Permalink to this definition">#</a></dt> <dd><p>Raise <a class="reference internal" href="#botcore.site_api.ResponseCodeError" title="botcore.site_api.ResponseCodeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a> for non-OK response if an exception should be raised.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -388,7 +388,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.patch"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">patch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L125-L128"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.patch" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">patch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L125-L128"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.patch" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PATCH passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -399,7 +399,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.post"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L129-L132"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.post" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L129-L132"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.post" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with POST passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -410,7 +410,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.put"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">put</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L133-L136"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.put" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">put</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L133-L136"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.put" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PUT passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -421,7 +421,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.request"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L100-L120"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.request" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L100-L120"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.request" title="Permalink to this definition">#</a></dt> <dd><p>Send an HTTP request to the site API and return the JSON response.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -448,12 +448,12 @@ <dl class="py exception"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L14-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L14-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></a></p> <p>Raised in <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> when a non-OK HTTP response is received.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L17-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L17-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#botcore.site_api.ResponseCodeError" title="botcore.site_api.ResponseCodeError"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -468,7 +468,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError.__str__"> -<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/site_api.py#L36-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__str__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/site_api.py#L36-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__str__" title="Permalink to this definition">#</a></dt> <dd><p>Return a string representation of the error.</p> </dd></dl> diff --git a/main/output/botcore.utils.caching.html b/main/output/botcore.utils.caching.html index 384fbe2b..dc5b270a 100644 --- a/main/output/botcore.utils.caching.html +++ b/main/output/botcore.utils.caching.html @@ -305,14 +305,14 @@ <p>Utilities related to custom caches.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>LRU cache implementation for coroutines.</p> <p>Once the cache exceeds the maximum size, keys are deleted in FIFO order.</p> <p>An offset may be optionally provided to be applied to the coroutine’s arguments when creating the cache key.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.__call__"> -<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__call__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__call__" title="Permalink to this definition">#</a></dt> <dd><p>Decorator for async cache.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -329,7 +329,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialise a new <a class="reference internal" href="#botcore.utils.caching.AsyncCache" title="botcore.utils.caching.AsyncCache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncCache</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -340,7 +340,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.clear"> -<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.clear" title="Permalink 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/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.clear" title="Permalink to this definition">#</a></dt> <dd><p>Clear cache instance.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> diff --git a/main/output/botcore.utils.channel.html b/main/output/botcore.utils.channel.html index cdeade53..26ef18b0 100644 --- a/main/output/botcore.utils.channel.html +++ b/main/output/botcore.utils.channel.html @@ -305,7 +305,7 @@ <p>Useful helper functions for interacting with various discord channel objects.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.channel.get_or_fetch_channel"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/channel.py#L25-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.get_or_fetch_channel" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/channel.py#L25-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.get_or_fetch_channel" title="Permalink to this definition">#</a></dt> <dd><p>Attempt to get or fetch the given <code class="docutils literal notranslate"><span class="pre">channel_id</span></code> from the bots cache, and return it.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -333,7 +333,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.channel.is_in_category"> -<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.is_in_category" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.is_in_category" title="Permalink to this definition">#</a></dt> <dd><p>Return whether the given <code class="docutils literal notranslate"><span class="pre">channel</span></code> in the the category with the id <code class="docutils literal notranslate"><span class="pre">category_id</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> diff --git a/main/output/botcore.utils.commands.html b/main/output/botcore.utils.commands.html index e16e4b0d..633344c3 100644 --- a/main/output/botcore.utils.commands.html +++ b/main/output/botcore.utils.commands.html @@ -304,7 +304,7 @@ <span id="commands"></span><h1>commands<a class="headerlink" href="#module-botcore.utils.commands" title="Permalink to this heading">#</a></h1> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.commands.clean_text_or_reply"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clean_text_or_reply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/commands.py#L7-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.commands.clean_text_or_reply" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clean_text_or_reply</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/commands.py#L7-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.commands.clean_text_or_reply" title="Permalink to this definition">#</a></dt> <dd><p>Cleans a text argument or replied message’s content.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> diff --git a/main/output/botcore.utils.html b/main/output/botcore.utils.html index 63935d87..d6d0fb70 100644 --- a/main/output/botcore.utils.html +++ b/main/output/botcore.utils.html @@ -305,7 +305,7 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.apply_monkey_patches"> -<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/__init__.py#L7-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/__init__.py#L7-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt> <dd><p>Applies all common monkey patches for our bots.</p> <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.0.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.0.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 @@ -324,7 +324,7 @@ that will act as top-level groups rather than being aliases of the command’s g <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.unqualify"> -<span class="sig-name descname"><span class="pre">unqualify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/_extensions.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.unqualify" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">unqualify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/_extensions.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.unqualify" title="Permalink to this definition">#</a></dt> <dd><p>Return an unqualified name given a qualified module/package <code class="docutils literal notranslate"><span class="pre">name</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> diff --git a/main/output/botcore.utils.interactions.html b/main/output/botcore.utils.interactions.html index 0e1fc054..14b129cc 100644 --- a/main/output/botcore.utils.interactions.html +++ b/main/output/botcore.utils.interactions.html @@ -304,7 +304,7 @@ <span id="interactions"></span><h1>interactions<a class="headerlink" href="#module-botcore.utils.interactions" title="Permalink to this heading">#</a></h1> <dl class="py class"> <dt class="sig sig-object py" id="botcore.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="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style=<ButtonStyle.secondary:</span> <span class="pre">2></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label='Delete'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/interactions.py#L73-L99"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.DeleteMessageButton" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DeleteMessageButton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style=<ButtonStyle.secondary:</span> <span class="pre">2></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label='Delete'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/interactions.py#L73-L99"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.DeleteMessageButton" title="Permalink 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.0.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> @@ -319,12 +319,12 @@ </dl> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.interactions.DeleteMessageButton.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style=<ButtonStyle.secondary:</span> <span class="pre">2></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label='Delete'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/interactions.py#L87-L95"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.DeleteMessageButton.__init__" title="Permalink 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">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style=<ButtonStyle.secondary:</span> <span class="pre">2></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label='Delete'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">**kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/interactions.py#L87-L95"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.DeleteMessageButton.__init__" title="Permalink to this definition">#</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.interactions.DeleteMessageButton.callback"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">callback</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/interactions.py#L96-L99"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.DeleteMessageButton.callback" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">callback</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/interactions.py#L96-L99"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.DeleteMessageButton.callback" title="Permalink to this definition">#</a></dt> <dd><p>Delete the original message on button click.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -337,7 +337,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/interactions.py#L11-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ViewWithUserAndRoleCheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/interactions.py#L11-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck" title="Permalink 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.0.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"> @@ -354,12 +354,12 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod </dl> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/interactions.py#L24-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/interactions.py#L24-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__" title="Permalink to this definition">#</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">interaction_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/interactions.py#L37-L64"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">interaction_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/interactions.py#L37-L64"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check" title="Permalink to this definition">#</a></dt> <dd><p>Ensure the user clicking the button is the view invoker, or a moderator.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -373,7 +373,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_timeout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/interactions.py#L65-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_timeout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/interactions.py#L65-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout" title="Permalink to this definition">#</a></dt> <dd><p>Remove the view from <code class="docutils literal notranslate"><span class="pre">self.message</span></code> if set.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> diff --git a/main/output/botcore.utils.logging.html b/main/output/botcore.utils.logging.html index 934a1823..55aa99f5 100644 --- a/main/output/botcore.utils.logging.html +++ b/main/output/botcore.utils.logging.html @@ -305,12 +305,12 @@ <p>Common logging related functions.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/logging.py#L14-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/logging.py#L14-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Logger</span></code></a></p> <p>Custom implementation of the <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.Logger</span></code></a> class with an added <a class="reference internal" href="#botcore.utils.logging.CustomLogger.trace" title="botcore.utils.logging.CustomLogger.trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trace</span></code></a> method.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger.trace"> -<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/logging.py#L17-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger.trace" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/logging.py#L17-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger.trace" title="Permalink to this definition">#</a></dt> <dd><p>Log the given message with the severity <code class="docutils literal notranslate"><span class="pre">"TRACE"</span></code>.</p> <p>To pass exception information, use the keyword argument exc_info with a true value:</p> <div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">logger</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s2">"Houston, we have an </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"interesting problem"</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> @@ -334,7 +334,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.logging.get_logger"> -<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/logging.py#L35-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.get_logger" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/logging.py#L35-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.get_logger" title="Permalink to this definition">#</a></dt> <dd><p>Utility to make mypy recognise that logger is of type <a class="reference internal" href="#botcore.utils.logging.CustomLogger" title="botcore.utils.logging.CustomLogger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CustomLogger</span></code></a>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> diff --git a/main/output/botcore.utils.members.html b/main/output/botcore.utils.members.html index 5f704337..c9b7a38c 100644 --- a/main/output/botcore.utils.members.html +++ b/main/output/botcore.utils.members.html @@ -305,7 +305,7 @@ <p>Useful helper functions for interactin with <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.0.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="botcore.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/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/members.py#L12-L29"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.get_or_fetch_member" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_member</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/members.py#L12-L29"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.get_or_fetch_member" title="Permalink 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> @@ -319,7 +319,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.members.handle_role_change"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_role_change</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/members.py#L31-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.handle_role_change" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_role_change</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/members.py#L31-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.handle_role_change" title="Permalink 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.0.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.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p> diff --git a/main/output/botcore.utils.regex.html b/main/output/botcore.utils.regex.html index 12915d43..aa6abd21 100644 --- a/main/output/botcore.utils.regex.html +++ b/main/output/botcore.utils.regex.html @@ -305,7 +305,7 @@ <p>Common regular expressions.</p> <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.DISCORD_INVITE"> -<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/regex.py#L5-L16"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.DISCORD_INVITE" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/regex.py#L5-L16"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.DISCORD_INVITE" title="Permalink to this definition">#</a></dt> <dd><p>Regex for Discord server invites.</p> <div class="admonition warning"> <p class="admonition-title">Warning</p> @@ -319,7 +319,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.FORMATTED_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/regex.py#L28-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.FORMATTED_CODE_REGEX" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/regex.py#L28-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.FORMATTED_CODE_REGEX" title="Permalink to this definition">#</a></dt> <dd><p>Regex for formatted code, using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> @@ -327,7 +327,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.RAW_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/regex.py#L43-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.RAW_CODE_REGEX" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/regex.py#L43-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.RAW_CODE_REGEX" title="Permalink to this definition">#</a></dt> <dd><p>Regex for raw code, <em>not</em> using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> diff --git a/main/output/botcore.utils.scheduling.html b/main/output/botcore.utils.scheduling.html index 6dae6060..54c80d5c 100644 --- a/main/output/botcore.utils.scheduling.html +++ b/main/output/botcore.utils.scheduling.html @@ -305,7 +305,7 @@ <p>Generic python scheduler.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/scheduling.py#L14-L210"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/scheduling.py#L14-L210"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>Schedule the execution of coroutines and keep track of them.</p> <p>When instantiating a <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a>, a name must be provided. This name is used to distinguish the @@ -319,7 +319,7 @@ the same ID used to schedule it.</p> <p>Any exception raised in a scheduled task is logged when the task is done.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.__contains__"> -<span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/scheduling.py#L44-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__contains__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/scheduling.py#L44-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__contains__" title="Permalink to this definition">#</a></dt> <dd><p>Return <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> if a task with the given <code class="docutils literal notranslate"><span class="pre">task_id</span></code> is currently scheduled.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -336,7 +336,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/scheduling.py#L32-L43"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/scheduling.py#L32-L43"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -347,7 +347,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.cancel"> -<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/scheduling.py#L126-L143"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/scheduling.py#L126-L143"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel" title="Permalink to this definition">#</a></dt> <dd><p>Unschedule the task identified by <code class="docutils literal notranslate"><span class="pre">task_id</span></code>. Log a warning if the task doesn’t exist.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -361,7 +361,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.cancel_all"> -<span class="sig-name descname"><span class="pre">cancel_all</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/scheduling.py#L144-L150"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel_all" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">cancel_all</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/scheduling.py#L144-L150"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel_all" title="Permalink to this definition">#</a></dt> <dd><p>Unschedule all known tasks.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -372,7 +372,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule"> -<span class="sig-name descname"><span class="pre">schedule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/scheduling.py#L56-L82"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/scheduling.py#L56-L82"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule" title="Permalink to this definition">#</a></dt> <dd><p>Schedule the execution of a <code class="docutils literal notranslate"><span class="pre">coroutine</span></code>.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> @@ -391,7 +391,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule_at"> -<span class="sig-name descname"><span class="pre">schedule_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/scheduling.py#L83-L106"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_at" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/scheduling.py#L83-L106"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_at" title="Permalink to this definition">#</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed at the given <code class="docutils literal notranslate"><span class="pre">time</span></code>.</p> <p>If <code class="docutils literal notranslate"><span class="pre">time</span></code> is timezone aware, then use that timezone to calculate now() when subtracting. If <code class="docutils literal notranslate"><span class="pre">time</span></code> is naïve, then use UTC.</p> @@ -414,7 +414,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule_later"> -<span class="sig-name descname"><span class="pre">schedule_later</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/scheduling.py#L107-L125"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_later" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule_later</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/scheduling.py#L107-L125"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_later" title="Permalink to this definition">#</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed after <code class="docutils literal notranslate"><span class="pre">delay</span></code> seconds.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> @@ -436,7 +436,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.scheduling.create_task"> -<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suppressed_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_loop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/2d7f51e990666c37cffb5f2a2e4d60d0457d3bc6/botcore/utils/scheduling.py#L215-L243"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.create_task" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suppressed_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_loop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c584af6f4791530f16aa32f30926c3d3e84fbcdd/botcore/utils/scheduling.py#L215-L243"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.create_task" title="Permalink to this definition">#</a></dt> <dd><p>Wrapper for creating an <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.Task</span></code></a> which logs exceptions raised in the task.</p> <p>If the <code class="docutils literal notranslate"><span class="pre">event_loop</span></code> kwarg is provided, the task is created from that event loop, otherwise the running loop is used.</p> diff --git a/v7.1.1/.buildinfo b/v7.1.1/.buildinfo index edc88cb7..7ee2ba3d 100644 --- a/v7.1.1/.buildinfo +++ b/v7.1.1/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: f820ec9a5f7141c10c6240b7b51da878 +config: 41b10eb9b809076e23286fd2bcfa8ede tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.1.1/.doctrees/changelog.doctree b/v7.1.1/.doctrees/changelog.doctree Binary files differindex 326336f9..03ae106f 100644 --- a/v7.1.1/.doctrees/changelog.doctree +++ b/v7.1.1/.doctrees/changelog.doctree diff --git a/v7.1.1/.doctrees/environment.pickle b/v7.1.1/.doctrees/environment.pickle Binary files differindex 1dc4407a..90010de4 100644 --- a/v7.1.1/.doctrees/environment.pickle +++ b/v7.1.1/.doctrees/environment.pickle diff --git a/v7.1.1/.doctrees/index.doctree b/v7.1.1/.doctrees/index.doctree Binary files differindex 345801b7..e1819eae 100644 --- a/v7.1.1/.doctrees/index.doctree +++ b/v7.1.1/.doctrees/index.doctree diff --git a/v7.1.1/.doctrees/output/botcore.async_stats.doctree b/v7.1.1/.doctrees/output/botcore.async_stats.doctree Binary files differindex 3aa1578b..bc88f336 100644 --- a/v7.1.1/.doctrees/output/botcore.async_stats.doctree +++ b/v7.1.1/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.1.1/.doctrees/output/botcore.doctree b/v7.1.1/.doctrees/output/botcore.doctree Binary files differindex 4ce152f9..559f476a 100644 --- a/v7.1.1/.doctrees/output/botcore.doctree +++ b/v7.1.1/.doctrees/output/botcore.doctree diff --git a/v7.1.1/.doctrees/output/botcore.exts.doctree b/v7.1.1/.doctrees/output/botcore.exts.doctree Binary files differindex 2b7ceee9..5559eb11 100644 --- a/v7.1.1/.doctrees/output/botcore.exts.doctree +++ b/v7.1.1/.doctrees/output/botcore.exts.doctree diff --git a/v7.1.1/.doctrees/output/botcore.site_api.doctree b/v7.1.1/.doctrees/output/botcore.site_api.doctree Binary files differindex 106daa1d..7cb59208 100644 --- a/v7.1.1/.doctrees/output/botcore.site_api.doctree +++ b/v7.1.1/.doctrees/output/botcore.site_api.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.caching.doctree b/v7.1.1/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 56b3ccf2..db18e918 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.channel.doctree b/v7.1.1/.doctrees/output/botcore.utils.channel.doctree Binary files differindex a0a5f0fa..69a2d966 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.doctree b/v7.1.1/.doctrees/output/botcore.utils.doctree Binary files differindex bb559325..19e4a85a 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.logging.doctree b/v7.1.1/.doctrees/output/botcore.utils.logging.doctree Binary files differindex 0ce43017..7316b2f8 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.members.doctree b/v7.1.1/.doctrees/output/botcore.utils.members.doctree Binary files differindex 795d8f10..3f0d0db9 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.members.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.regex.doctree b/v7.1.1/.doctrees/output/botcore.utils.regex.doctree Binary files differindex ef2db697..c0d72378 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree b/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex a42e3288..9fc9ac42 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.1.2/.buildinfo b/v7.1.2/.buildinfo index dbc57baf..105f3621 100644 --- a/v7.1.2/.buildinfo +++ b/v7.1.2/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 872ebe843cfcfa2bcc2954ea43438ef5 +config: 54123ef2736446bc932340339659c2a0 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.1.2/.doctrees/changelog.doctree b/v7.1.2/.doctrees/changelog.doctree Binary files differindex 63399c76..28526ced 100644 --- a/v7.1.2/.doctrees/changelog.doctree +++ b/v7.1.2/.doctrees/changelog.doctree diff --git a/v7.1.2/.doctrees/environment.pickle b/v7.1.2/.doctrees/environment.pickle Binary files differindex 77119f3c..987b6ffa 100644 --- a/v7.1.2/.doctrees/environment.pickle +++ b/v7.1.2/.doctrees/environment.pickle diff --git a/v7.1.2/.doctrees/index.doctree b/v7.1.2/.doctrees/index.doctree Binary files differindex 2f71e251..e8870bae 100644 --- a/v7.1.2/.doctrees/index.doctree +++ b/v7.1.2/.doctrees/index.doctree diff --git a/v7.1.2/.doctrees/output/botcore.async_stats.doctree b/v7.1.2/.doctrees/output/botcore.async_stats.doctree Binary files differindex 01da7495..3baf83a8 100644 --- a/v7.1.2/.doctrees/output/botcore.async_stats.doctree +++ b/v7.1.2/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.1.2/.doctrees/output/botcore.doctree b/v7.1.2/.doctrees/output/botcore.doctree Binary files differindex 2dba999a..d112b2f9 100644 --- a/v7.1.2/.doctrees/output/botcore.doctree +++ b/v7.1.2/.doctrees/output/botcore.doctree diff --git a/v7.1.2/.doctrees/output/botcore.exts.doctree b/v7.1.2/.doctrees/output/botcore.exts.doctree Binary files differindex 745bfd72..5ae7b038 100644 --- a/v7.1.2/.doctrees/output/botcore.exts.doctree +++ b/v7.1.2/.doctrees/output/botcore.exts.doctree diff --git a/v7.1.2/.doctrees/output/botcore.site_api.doctree b/v7.1.2/.doctrees/output/botcore.site_api.doctree Binary files differindex 33418b5c..24d17a52 100644 --- a/v7.1.2/.doctrees/output/botcore.site_api.doctree +++ b/v7.1.2/.doctrees/output/botcore.site_api.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.caching.doctree b/v7.1.2/.doctrees/output/botcore.utils.caching.doctree Binary files differindex e8c3b8d5..51bb8030 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.channel.doctree b/v7.1.2/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 45863521..fce2e8bc 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.doctree b/v7.1.2/.doctrees/output/botcore.utils.doctree Binary files differindex 98879518..54783df4 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.logging.doctree b/v7.1.2/.doctrees/output/botcore.utils.logging.doctree Binary files differindex 85e0a0bb..f29824fe 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.members.doctree b/v7.1.2/.doctrees/output/botcore.utils.members.doctree Binary files differindex a770c772..2303f51a 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.members.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.regex.doctree b/v7.1.2/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 51aa9a5d..f595debf 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree b/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex 4b0b4324..669340c6 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.1.3/.buildinfo b/v7.1.3/.buildinfo index 26b835dc..e4ab51ec 100644 --- a/v7.1.3/.buildinfo +++ b/v7.1.3/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 8585c237a4ff953ee5cb9099c771b210 +config: 5c824700ed0c6ef5c15eae2dee577c79 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.1.3/.doctrees/changelog.doctree b/v7.1.3/.doctrees/changelog.doctree Binary files differindex ce9ced2b..3afba5dc 100644 --- a/v7.1.3/.doctrees/changelog.doctree +++ b/v7.1.3/.doctrees/changelog.doctree diff --git a/v7.1.3/.doctrees/environment.pickle b/v7.1.3/.doctrees/environment.pickle Binary files differindex c384a8e6..9ee2d4de 100644 --- a/v7.1.3/.doctrees/environment.pickle +++ b/v7.1.3/.doctrees/environment.pickle diff --git a/v7.1.3/.doctrees/index.doctree b/v7.1.3/.doctrees/index.doctree Binary files differindex 8f4b4698..4c0fc0f3 100644 --- a/v7.1.3/.doctrees/index.doctree +++ b/v7.1.3/.doctrees/index.doctree diff --git a/v7.1.3/.doctrees/output/botcore.async_stats.doctree b/v7.1.3/.doctrees/output/botcore.async_stats.doctree Binary files differindex 5a6e7215..66844c8c 100644 --- a/v7.1.3/.doctrees/output/botcore.async_stats.doctree +++ b/v7.1.3/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.1.3/.doctrees/output/botcore.doctree b/v7.1.3/.doctrees/output/botcore.doctree Binary files differindex b629f65c..b3ee7a3e 100644 --- a/v7.1.3/.doctrees/output/botcore.doctree +++ b/v7.1.3/.doctrees/output/botcore.doctree diff --git a/v7.1.3/.doctrees/output/botcore.exts.doctree b/v7.1.3/.doctrees/output/botcore.exts.doctree Binary files differindex c0741a0a..c0fdd9a2 100644 --- a/v7.1.3/.doctrees/output/botcore.exts.doctree +++ b/v7.1.3/.doctrees/output/botcore.exts.doctree diff --git a/v7.1.3/.doctrees/output/botcore.site_api.doctree b/v7.1.3/.doctrees/output/botcore.site_api.doctree Binary files differindex a2382a9b..07a36ff4 100644 --- a/v7.1.3/.doctrees/output/botcore.site_api.doctree +++ b/v7.1.3/.doctrees/output/botcore.site_api.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.caching.doctree b/v7.1.3/.doctrees/output/botcore.utils.caching.doctree Binary files differindex bae1c7f6..2415904a 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.channel.doctree b/v7.1.3/.doctrees/output/botcore.utils.channel.doctree Binary files differindex c307dfdb..3fbdc726 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.doctree b/v7.1.3/.doctrees/output/botcore.utils.doctree Binary files differindex 05048a29..588ebbb3 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.logging.doctree b/v7.1.3/.doctrees/output/botcore.utils.logging.doctree Binary files differindex f85a973c..71acb3fb 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.members.doctree b/v7.1.3/.doctrees/output/botcore.utils.members.doctree Binary files differindex a2c779af..636045dd 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.members.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.regex.doctree b/v7.1.3/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 72cc04bf..7d0ca84c 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree b/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex abc09d71..95ea1861 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.2.0/.buildinfo b/v7.2.0/.buildinfo index bd9523c1..39595cde 100644 --- a/v7.2.0/.buildinfo +++ b/v7.2.0/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: ff8f0102e9db25622e6e8eb6d1f51ac4 +config: 92806dd392c75a18e9da5b500aefc024 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.2.0/.doctrees/changelog.doctree b/v7.2.0/.doctrees/changelog.doctree Binary files differindex 022701a2..03a10539 100644 --- a/v7.2.0/.doctrees/changelog.doctree +++ b/v7.2.0/.doctrees/changelog.doctree diff --git a/v7.2.0/.doctrees/environment.pickle b/v7.2.0/.doctrees/environment.pickle Binary files differindex d4f01eb7..e4707071 100644 --- a/v7.2.0/.doctrees/environment.pickle +++ b/v7.2.0/.doctrees/environment.pickle diff --git a/v7.2.0/.doctrees/index.doctree b/v7.2.0/.doctrees/index.doctree Binary files differindex 75a781f5..ca558611 100644 --- a/v7.2.0/.doctrees/index.doctree +++ b/v7.2.0/.doctrees/index.doctree diff --git a/v7.2.0/.doctrees/output/botcore.async_stats.doctree b/v7.2.0/.doctrees/output/botcore.async_stats.doctree Binary files differindex ec1ea4ad..565c7815 100644 --- a/v7.2.0/.doctrees/output/botcore.async_stats.doctree +++ b/v7.2.0/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.2.0/.doctrees/output/botcore.doctree b/v7.2.0/.doctrees/output/botcore.doctree Binary files differindex d578e3fa..b15c89fe 100644 --- a/v7.2.0/.doctrees/output/botcore.doctree +++ b/v7.2.0/.doctrees/output/botcore.doctree diff --git a/v7.2.0/.doctrees/output/botcore.exts.doctree b/v7.2.0/.doctrees/output/botcore.exts.doctree Binary files differindex daab19f1..5a2b1b53 100644 --- a/v7.2.0/.doctrees/output/botcore.exts.doctree +++ b/v7.2.0/.doctrees/output/botcore.exts.doctree diff --git a/v7.2.0/.doctrees/output/botcore.site_api.doctree b/v7.2.0/.doctrees/output/botcore.site_api.doctree Binary files differindex 59b0d5b1..528305b8 100644 --- a/v7.2.0/.doctrees/output/botcore.site_api.doctree +++ b/v7.2.0/.doctrees/output/botcore.site_api.doctree diff --git a/v7.2.0/.doctrees/output/botcore.utils.caching.doctree b/v7.2.0/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 5e89dedb..03fe7adb 100644 --- a/v7.2.0/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.2.0/.doctrees/output/botcore.utils.channel.doctree b/v7.2.0/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 59534989..72a984ce 100644 --- a/v7.2.0/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.2.0/.doctrees/output/botcore.utils.doctree b/v7.2.0/.doctrees/output/botcore.utils.doctree Binary files differindex 12923480..d261ac33 100644 --- a/v7.2.0/.doctrees/output/botcore.utils.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.doctree diff --git a/v7.2.0/.doctrees/output/botcore.utils.logging.doctree b/v7.2.0/.doctrees/output/botcore.utils.logging.doctree Binary files differindex b3f3a85d..da063772 100644 --- a/v7.2.0/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.2.0/.doctrees/output/botcore.utils.members.doctree b/v7.2.0/.doctrees/output/botcore.utils.members.doctree Binary files differindex 9676245c..a4a6cba5 100644 --- a/v7.2.0/.doctrees/output/botcore.utils.members.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.2.0/.doctrees/output/botcore.utils.regex.doctree b/v7.2.0/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 4ea122e8..23b888c0 100644 --- a/v7.2.0/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree b/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex 06bf12ae..1579c395 100644 --- a/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.2.1/.buildinfo b/v7.2.1/.buildinfo index 298e719c..2dd999db 100644 --- a/v7.2.1/.buildinfo +++ b/v7.2.1/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: ae9d8bea6a710da85792b29c8e4854a7 +config: 7a7419260d69ae5702ca2fe7e4b72a8f tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.2.1/.doctrees/changelog.doctree b/v7.2.1/.doctrees/changelog.doctree Binary files differindex 414d05f1..00d8a9f3 100644 --- a/v7.2.1/.doctrees/changelog.doctree +++ b/v7.2.1/.doctrees/changelog.doctree diff --git a/v7.2.1/.doctrees/environment.pickle b/v7.2.1/.doctrees/environment.pickle Binary files differindex 540df593..1fc82193 100644 --- a/v7.2.1/.doctrees/environment.pickle +++ b/v7.2.1/.doctrees/environment.pickle diff --git a/v7.2.1/.doctrees/index.doctree b/v7.2.1/.doctrees/index.doctree Binary files differindex f383a85d..70ba8871 100644 --- a/v7.2.1/.doctrees/index.doctree +++ b/v7.2.1/.doctrees/index.doctree diff --git a/v7.2.1/.doctrees/output/botcore.async_stats.doctree b/v7.2.1/.doctrees/output/botcore.async_stats.doctree Binary files differindex 6b15c8b5..683c9337 100644 --- a/v7.2.1/.doctrees/output/botcore.async_stats.doctree +++ b/v7.2.1/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.2.1/.doctrees/output/botcore.doctree b/v7.2.1/.doctrees/output/botcore.doctree Binary files differindex e7b50efd..ad5d091e 100644 --- a/v7.2.1/.doctrees/output/botcore.doctree +++ b/v7.2.1/.doctrees/output/botcore.doctree diff --git a/v7.2.1/.doctrees/output/botcore.exts.doctree b/v7.2.1/.doctrees/output/botcore.exts.doctree Binary files differindex a6d7d89e..cb781a35 100644 --- a/v7.2.1/.doctrees/output/botcore.exts.doctree +++ b/v7.2.1/.doctrees/output/botcore.exts.doctree diff --git a/v7.2.1/.doctrees/output/botcore.site_api.doctree b/v7.2.1/.doctrees/output/botcore.site_api.doctree Binary files differindex 20f723b9..5868d6ff 100644 --- a/v7.2.1/.doctrees/output/botcore.site_api.doctree +++ b/v7.2.1/.doctrees/output/botcore.site_api.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.caching.doctree b/v7.2.1/.doctrees/output/botcore.utils.caching.doctree Binary files differindex f8a19a5a..0b992b2f 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.channel.doctree b/v7.2.1/.doctrees/output/botcore.utils.channel.doctree Binary files differindex eb77098d..da20803c 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.doctree b/v7.2.1/.doctrees/output/botcore.utils.doctree Binary files differindex 954078c1..6260f22c 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.logging.doctree b/v7.2.1/.doctrees/output/botcore.utils.logging.doctree Binary files differindex d171f0bb..002429b1 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.members.doctree b/v7.2.1/.doctrees/output/botcore.utils.members.doctree Binary files differindex 55fb8b2f..573895b7 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.members.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.regex.doctree b/v7.2.1/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 217d41f4..6d93c5c5 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree b/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex c0094f34..f8ac4154 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.2.2/.buildinfo b/v7.2.2/.buildinfo index 8140b93a..30fc0dbd 100644 --- a/v7.2.2/.buildinfo +++ b/v7.2.2/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 3391f84b6d5de69d59524e21a4181573 +config: 3da8f526e0f273ca22af39c8cfd654ee tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.2.2/.doctrees/changelog.doctree b/v7.2.2/.doctrees/changelog.doctree Binary files differindex 7d069653..bbe22735 100644 --- a/v7.2.2/.doctrees/changelog.doctree +++ b/v7.2.2/.doctrees/changelog.doctree diff --git a/v7.2.2/.doctrees/environment.pickle b/v7.2.2/.doctrees/environment.pickle Binary files differindex ad6fbdd2..23505e2a 100644 --- a/v7.2.2/.doctrees/environment.pickle +++ b/v7.2.2/.doctrees/environment.pickle diff --git a/v7.2.2/.doctrees/index.doctree b/v7.2.2/.doctrees/index.doctree Binary files differindex 754d3588..f978eab2 100644 --- a/v7.2.2/.doctrees/index.doctree +++ b/v7.2.2/.doctrees/index.doctree diff --git a/v7.2.2/.doctrees/output/botcore.async_stats.doctree b/v7.2.2/.doctrees/output/botcore.async_stats.doctree Binary files differindex 3a06eb1d..cd89dca4 100644 --- a/v7.2.2/.doctrees/output/botcore.async_stats.doctree +++ b/v7.2.2/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.2.2/.doctrees/output/botcore.doctree b/v7.2.2/.doctrees/output/botcore.doctree Binary files differindex 409919a3..88e37b47 100644 --- a/v7.2.2/.doctrees/output/botcore.doctree +++ b/v7.2.2/.doctrees/output/botcore.doctree diff --git a/v7.2.2/.doctrees/output/botcore.exts.doctree b/v7.2.2/.doctrees/output/botcore.exts.doctree Binary files differindex 74547cf7..32fff936 100644 --- a/v7.2.2/.doctrees/output/botcore.exts.doctree +++ b/v7.2.2/.doctrees/output/botcore.exts.doctree diff --git a/v7.2.2/.doctrees/output/botcore.site_api.doctree b/v7.2.2/.doctrees/output/botcore.site_api.doctree Binary files differindex 431ee4ee..fbfd6046 100644 --- a/v7.2.2/.doctrees/output/botcore.site_api.doctree +++ b/v7.2.2/.doctrees/output/botcore.site_api.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.caching.doctree b/v7.2.2/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 9b853156..26a48397 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.channel.doctree b/v7.2.2/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 38499d05..384c46c9 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.doctree b/v7.2.2/.doctrees/output/botcore.utils.doctree Binary files differindex 992f840c..a973f917 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.logging.doctree b/v7.2.2/.doctrees/output/botcore.utils.logging.doctree Binary files differindex c7353e87..bca4849f 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.members.doctree b/v7.2.2/.doctrees/output/botcore.utils.members.doctree Binary files differindex 286c34ae..325cb5f9 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.members.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.regex.doctree b/v7.2.2/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 6adb1d6c..44269ab2 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.scheduling.doctree b/v7.2.2/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex eaac382a..6f9b9c8e 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.3.0/.buildinfo b/v7.3.0/.buildinfo index b6324f2f..c130bb9b 100644 --- a/v7.3.0/.buildinfo +++ b/v7.3.0/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: ad89c81ae2c310419f262943a7b04661 +config: 689b9fcee6b741c3ab869ad1a5889122 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.3.0/.doctrees/changelog.doctree b/v7.3.0/.doctrees/changelog.doctree Binary files differindex b50d2fd8..863dfd18 100644 --- a/v7.3.0/.doctrees/changelog.doctree +++ b/v7.3.0/.doctrees/changelog.doctree diff --git a/v7.3.0/.doctrees/environment.pickle b/v7.3.0/.doctrees/environment.pickle Binary files differindex e6426c24..a0386a67 100644 --- a/v7.3.0/.doctrees/environment.pickle +++ b/v7.3.0/.doctrees/environment.pickle diff --git a/v7.3.0/.doctrees/index.doctree b/v7.3.0/.doctrees/index.doctree Binary files differindex b9effdce..64b88bcc 100644 --- a/v7.3.0/.doctrees/index.doctree +++ b/v7.3.0/.doctrees/index.doctree diff --git a/v7.3.0/.doctrees/output/botcore.async_stats.doctree b/v7.3.0/.doctrees/output/botcore.async_stats.doctree Binary files differindex f293b4ef..b5f74d8c 100644 --- a/v7.3.0/.doctrees/output/botcore.async_stats.doctree +++ b/v7.3.0/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.3.0/.doctrees/output/botcore.doctree b/v7.3.0/.doctrees/output/botcore.doctree Binary files differindex 78bf99cb..fc49713b 100644 --- a/v7.3.0/.doctrees/output/botcore.doctree +++ b/v7.3.0/.doctrees/output/botcore.doctree diff --git a/v7.3.0/.doctrees/output/botcore.exts.doctree b/v7.3.0/.doctrees/output/botcore.exts.doctree Binary files differindex 3d2e592d..1c6ae023 100644 --- a/v7.3.0/.doctrees/output/botcore.exts.doctree +++ b/v7.3.0/.doctrees/output/botcore.exts.doctree diff --git a/v7.3.0/.doctrees/output/botcore.site_api.doctree b/v7.3.0/.doctrees/output/botcore.site_api.doctree Binary files differindex f9243bb8..2b07b6f9 100644 --- a/v7.3.0/.doctrees/output/botcore.site_api.doctree +++ b/v7.3.0/.doctrees/output/botcore.site_api.doctree diff --git a/v7.3.0/.doctrees/output/botcore.utils.caching.doctree b/v7.3.0/.doctrees/output/botcore.utils.caching.doctree Binary files differindex b0f78c7b..07f64ef9 100644 --- a/v7.3.0/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.3.0/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.3.0/.doctrees/output/botcore.utils.channel.doctree b/v7.3.0/.doctrees/output/botcore.utils.channel.doctree Binary files differindex e4bddb4d..8a0f1fc0 100644 --- a/v7.3.0/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.3.0/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.3.0/.doctrees/output/botcore.utils.doctree b/v7.3.0/.doctrees/output/botcore.utils.doctree Binary files differindex 769f2fe3..548eeabd 100644 --- a/v7.3.0/.doctrees/output/botcore.utils.doctree +++ b/v7.3.0/.doctrees/output/botcore.utils.doctree diff --git a/v7.3.0/.doctrees/output/botcore.utils.interactions.doctree b/v7.3.0/.doctrees/output/botcore.utils.interactions.doctree Binary files differindex 1e172267..acb5af2a 100644 --- a/v7.3.0/.doctrees/output/botcore.utils.interactions.doctree +++ b/v7.3.0/.doctrees/output/botcore.utils.interactions.doctree diff --git a/v7.3.0/.doctrees/output/botcore.utils.logging.doctree b/v7.3.0/.doctrees/output/botcore.utils.logging.doctree Binary files differindex d0fab870..c5d96f02 100644 --- a/v7.3.0/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.3.0/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.3.0/.doctrees/output/botcore.utils.members.doctree b/v7.3.0/.doctrees/output/botcore.utils.members.doctree Binary files differindex e1acb450..2d835bdf 100644 --- a/v7.3.0/.doctrees/output/botcore.utils.members.doctree +++ b/v7.3.0/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.3.0/.doctrees/output/botcore.utils.regex.doctree b/v7.3.0/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 70e48de5..1ef14096 100644 --- a/v7.3.0/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.3.0/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.3.0/.doctrees/output/botcore.utils.scheduling.doctree b/v7.3.0/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex 84246973..29563cbf 100644 --- a/v7.3.0/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.3.0/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.3.1/.buildinfo b/v7.3.1/.buildinfo index 82a114c0..8b2e6aeb 100644 --- a/v7.3.1/.buildinfo +++ b/v7.3.1/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: ea586f6b19d6c7fc9f185676699863de +config: f4049c39df5dbcfa83c8a731a327e774 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.3.1/.doctrees/changelog.doctree b/v7.3.1/.doctrees/changelog.doctree Binary files differindex 9b161ab8..8fb4aa74 100644 --- a/v7.3.1/.doctrees/changelog.doctree +++ b/v7.3.1/.doctrees/changelog.doctree diff --git a/v7.3.1/.doctrees/environment.pickle b/v7.3.1/.doctrees/environment.pickle Binary files differindex 4cf55937..73661cef 100644 --- a/v7.3.1/.doctrees/environment.pickle +++ b/v7.3.1/.doctrees/environment.pickle diff --git a/v7.3.1/.doctrees/index.doctree b/v7.3.1/.doctrees/index.doctree Binary files differindex 422b1d27..e40fd856 100644 --- a/v7.3.1/.doctrees/index.doctree +++ b/v7.3.1/.doctrees/index.doctree diff --git a/v7.3.1/.doctrees/output/botcore.async_stats.doctree b/v7.3.1/.doctrees/output/botcore.async_stats.doctree Binary files differindex e7129783..b7729f79 100644 --- a/v7.3.1/.doctrees/output/botcore.async_stats.doctree +++ b/v7.3.1/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.3.1/.doctrees/output/botcore.doctree b/v7.3.1/.doctrees/output/botcore.doctree Binary files differindex 366adccf..dac37892 100644 --- a/v7.3.1/.doctrees/output/botcore.doctree +++ b/v7.3.1/.doctrees/output/botcore.doctree diff --git a/v7.3.1/.doctrees/output/botcore.exts.doctree b/v7.3.1/.doctrees/output/botcore.exts.doctree Binary files differindex 24578fc9..1c1585f4 100644 --- a/v7.3.1/.doctrees/output/botcore.exts.doctree +++ b/v7.3.1/.doctrees/output/botcore.exts.doctree diff --git a/v7.3.1/.doctrees/output/botcore.site_api.doctree b/v7.3.1/.doctrees/output/botcore.site_api.doctree Binary files differindex c1df51c2..3ad733ab 100644 --- a/v7.3.1/.doctrees/output/botcore.site_api.doctree +++ b/v7.3.1/.doctrees/output/botcore.site_api.doctree diff --git a/v7.3.1/.doctrees/output/botcore.utils.caching.doctree b/v7.3.1/.doctrees/output/botcore.utils.caching.doctree Binary files differindex c4535980..666d4226 100644 --- a/v7.3.1/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.3.1/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.3.1/.doctrees/output/botcore.utils.channel.doctree b/v7.3.1/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 0a4374cf..c96b17a5 100644 --- a/v7.3.1/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.3.1/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.3.1/.doctrees/output/botcore.utils.doctree b/v7.3.1/.doctrees/output/botcore.utils.doctree Binary files differindex f8f64c3a..8c50ed0a 100644 --- a/v7.3.1/.doctrees/output/botcore.utils.doctree +++ b/v7.3.1/.doctrees/output/botcore.utils.doctree diff --git a/v7.3.1/.doctrees/output/botcore.utils.interactions.doctree b/v7.3.1/.doctrees/output/botcore.utils.interactions.doctree Binary files differindex 7ec01d16..d1522b9c 100644 --- a/v7.3.1/.doctrees/output/botcore.utils.interactions.doctree +++ b/v7.3.1/.doctrees/output/botcore.utils.interactions.doctree diff --git a/v7.3.1/.doctrees/output/botcore.utils.logging.doctree b/v7.3.1/.doctrees/output/botcore.utils.logging.doctree Binary files differindex 2d858245..ac50e3ff 100644 --- a/v7.3.1/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.3.1/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.3.1/.doctrees/output/botcore.utils.members.doctree b/v7.3.1/.doctrees/output/botcore.utils.members.doctree Binary files differindex fff6f415..50519db2 100644 --- a/v7.3.1/.doctrees/output/botcore.utils.members.doctree +++ b/v7.3.1/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.3.1/.doctrees/output/botcore.utils.regex.doctree b/v7.3.1/.doctrees/output/botcore.utils.regex.doctree Binary files differindex d44b4a8a..4e365a1d 100644 --- a/v7.3.1/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.3.1/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.3.1/.doctrees/output/botcore.utils.scheduling.doctree b/v7.3.1/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex 8dbc7345..35ad4c49 100644 --- a/v7.3.1/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.3.1/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.4.0-beta1/.buildinfo b/v7.4.0-beta1/.buildinfo index 656f2ed6..7a9a885a 100644 --- a/v7.4.0-beta1/.buildinfo +++ b/v7.4.0-beta1/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: dd3634a558272f436954a8be2e6fef3b +config: 340f1ca9f55d170a60b96346c7a1d395 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.4.0-beta1/.doctrees/changelog.doctree b/v7.4.0-beta1/.doctrees/changelog.doctree Binary files differindex 8ec62d03..7ed71b0f 100644 --- a/v7.4.0-beta1/.doctrees/changelog.doctree +++ b/v7.4.0-beta1/.doctrees/changelog.doctree diff --git a/v7.4.0-beta1/.doctrees/environment.pickle b/v7.4.0-beta1/.doctrees/environment.pickle Binary files differindex c3b08e29..c9a8c1bc 100644 --- a/v7.4.0-beta1/.doctrees/environment.pickle +++ b/v7.4.0-beta1/.doctrees/environment.pickle diff --git a/v7.4.0-beta1/.doctrees/index.doctree b/v7.4.0-beta1/.doctrees/index.doctree Binary files differindex ec85df74..44502df9 100644 --- a/v7.4.0-beta1/.doctrees/index.doctree +++ b/v7.4.0-beta1/.doctrees/index.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.async_stats.doctree b/v7.4.0-beta1/.doctrees/output/botcore.async_stats.doctree Binary files differindex 3d3d86b3..a7356f5d 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.async_stats.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.doctree b/v7.4.0-beta1/.doctrees/output/botcore.doctree Binary files differindex d577184e..18360fd1 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.exts.doctree b/v7.4.0-beta1/.doctrees/output/botcore.exts.doctree Binary files differindex b01b853b..d78dd7c6 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.exts.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.exts.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.site_api.doctree b/v7.4.0-beta1/.doctrees/output/botcore.site_api.doctree Binary files differindex b5895289..cd3d8cd4 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.site_api.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.site_api.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.utils.caching.doctree b/v7.4.0-beta1/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 43b77413..e22f6ed5 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.utils.channel.doctree b/v7.4.0-beta1/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 13c36c02..979ab6fe 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.utils.doctree b/v7.4.0-beta1/.doctrees/output/botcore.utils.doctree Binary files differindex bb93c061..17c7cbaf 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.utils.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.utils.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.utils.interactions.doctree b/v7.4.0-beta1/.doctrees/output/botcore.utils.interactions.doctree Binary files differindex 41a4ec38..8c39fed9 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.utils.interactions.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.utils.interactions.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.utils.logging.doctree b/v7.4.0-beta1/.doctrees/output/botcore.utils.logging.doctree Binary files differindex c26db657..41cbef9b 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.utils.members.doctree b/v7.4.0-beta1/.doctrees/output/botcore.utils.members.doctree Binary files differindex ee316e86..ef836230 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.utils.members.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.utils.regex.doctree b/v7.4.0-beta1/.doctrees/output/botcore.utils.regex.doctree Binary files differindex eb2c2ae2..e6fbc68e 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.4.0-beta1/.doctrees/output/botcore.utils.scheduling.doctree b/v7.4.0-beta1/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex bcae8232..18c8fbfa 100644 --- a/v7.4.0-beta1/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.4.0-beta1/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.4.0/.buildinfo b/v7.4.0/.buildinfo index d57a9d6c..29c42584 100644 --- a/v7.4.0/.buildinfo +++ b/v7.4.0/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 1ab0dc60ed6ab23136b999e6efa657bb +config: 5e5946073462df65a201f2d9cd2873bc tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.4.0/.doctrees/changelog.doctree b/v7.4.0/.doctrees/changelog.doctree Binary files differindex a09782d5..a263fc31 100644 --- a/v7.4.0/.doctrees/changelog.doctree +++ b/v7.4.0/.doctrees/changelog.doctree diff --git a/v7.4.0/.doctrees/environment.pickle b/v7.4.0/.doctrees/environment.pickle Binary files differindex 30547700..5e51dcd7 100644 --- a/v7.4.0/.doctrees/environment.pickle +++ b/v7.4.0/.doctrees/environment.pickle diff --git a/v7.4.0/.doctrees/index.doctree b/v7.4.0/.doctrees/index.doctree Binary files differindex 0b036f8e..6d76e200 100644 --- a/v7.4.0/.doctrees/index.doctree +++ b/v7.4.0/.doctrees/index.doctree diff --git a/v7.4.0/.doctrees/output/botcore.async_stats.doctree b/v7.4.0/.doctrees/output/botcore.async_stats.doctree Binary files differindex 7e28285f..8ee699df 100644 --- a/v7.4.0/.doctrees/output/botcore.async_stats.doctree +++ b/v7.4.0/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.4.0/.doctrees/output/botcore.doctree b/v7.4.0/.doctrees/output/botcore.doctree Binary files differindex 871daf37..dee379c5 100644 --- a/v7.4.0/.doctrees/output/botcore.doctree +++ b/v7.4.0/.doctrees/output/botcore.doctree diff --git a/v7.4.0/.doctrees/output/botcore.exts.doctree b/v7.4.0/.doctrees/output/botcore.exts.doctree Binary files differindex f831700f..848d40ac 100644 --- a/v7.4.0/.doctrees/output/botcore.exts.doctree +++ b/v7.4.0/.doctrees/output/botcore.exts.doctree diff --git a/v7.4.0/.doctrees/output/botcore.site_api.doctree b/v7.4.0/.doctrees/output/botcore.site_api.doctree Binary files differindex 4e91ac4d..99c31313 100644 --- a/v7.4.0/.doctrees/output/botcore.site_api.doctree +++ b/v7.4.0/.doctrees/output/botcore.site_api.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.caching.doctree b/v7.4.0/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 67304dd7..f9c68dae 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.channel.doctree b/v7.4.0/.doctrees/output/botcore.utils.channel.doctree Binary files differindex df1ea2bf..47596ec0 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.doctree b/v7.4.0/.doctrees/output/botcore.utils.doctree Binary files differindex e764f43f..f2bc96ee 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree b/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree Binary files differindex f400cc8b..ee2fba94 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.logging.doctree b/v7.4.0/.doctrees/output/botcore.utils.logging.doctree Binary files differindex 3ff38015..79cc5cb6 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.members.doctree b/v7.4.0/.doctrees/output/botcore.utils.members.doctree Binary files differindex 61fe8342..01ffacf0 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.members.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.regex.doctree b/v7.4.0/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 35f196f7..a3ab4c0b 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree b/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex 472e6e4e..efbd1da0 100644 --- a/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree |