diff options
Diffstat (limited to 'v7.3.0')
34 files changed, 96 insertions, 18 deletions
diff --git a/v7.3.0/.buildinfo b/v7.3.0/.buildinfo index 93d553b0..e7faeea1 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: f33bc593295c6d2d262df12ed7498cfc +config: 9e7103b75c7d14b6bf71437d6a4cb7b7 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.3.0/.doctrees/changelog.doctree b/v7.3.0/.doctrees/changelog.doctree Binary files differindex 23b098f7..18ec76fd 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 63388e37..3d001677 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 aabae443..68665df0 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 72b2161a..f6e1d4f5 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 fc12fccb..9a8f7011 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 dea2e523..16630f7d 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 13b870d5..90c10615 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 3c91220f..1a8e96c6 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 d291162d..fa08ab92 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 11350d96..b8e725bf 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 9e105fe4..410300a1 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 84bea44f..a4c8af1e 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 93b090e4..11e24fcc 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 ecd13cef..2b5fb462 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 04dd25a0..10328321 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.0/changelog.html b/v7.3.0/changelog.html index 808e5c42..518c5dc0 100644 --- a/v7.3.0/changelog.html +++ b/v7.3.0/changelog.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v7.4.0/changelog.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v7.3.1/changelog.html">v7.3.1</a> </li> diff --git a/v7.3.0/genindex.html b/v7.3.0/genindex.html index 1de75b33..f8ee6b04 100644 --- a/v7.3.0/genindex.html +++ b/v7.3.0/genindex.html @@ -208,6 +208,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v7.4.0/index.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v7.3.1/index.html">v7.3.1</a> </li> diff --git a/v7.3.0/index.html b/v7.3.0/index.html index 17ae366b..910ee795 100644 --- a/v7.3.0/index.html +++ b/v7.3.0/index.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v7.4.0/index.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v7.3.1/index.html">v7.3.1</a> </li> diff --git a/v7.3.0/output/botcore.async_stats.html b/v7.3.0/output/botcore.async_stats.html index 28771bc0..64b22125 100644 --- a/v7.3.0/output/botcore.async_stats.html +++ b/v7.3.0/output/botcore.async_stats.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.async_stats.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.async_stats.html">v7.3.1</a> </li> diff --git a/v7.3.0/output/botcore.exts.html b/v7.3.0/output/botcore.exts.html index 9b809de9..ac0e4249 100644 --- a/v7.3.0/output/botcore.exts.html +++ b/v7.3.0/output/botcore.exts.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.exts.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.exts.html">v7.3.1</a> </li> diff --git a/v7.3.0/output/botcore.html b/v7.3.0/output/botcore.html index bd039cd8..e2a999b1 100644 --- a/v7.3.0/output/botcore.html +++ b/v7.3.0/output/botcore.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.html">v7.3.1</a> </li> @@ -300,12 +304,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -324,7 +328,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -335,7 +339,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -346,7 +350,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -357,7 +361,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -368,7 +372,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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"> @@ -380,7 +384,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -391,7 +395,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -404,7 +408,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -415,7 +419,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -426,7 +430,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -439,7 +443,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -453,7 +457,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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> @@ -468,12 +472,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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/v7.3.0/output/botcore.site_api.html b/v7.3.0/output/botcore.site_api.html index 1c82ab14..d96bb93c 100644 --- a/v7.3.0/output/botcore.site_api.html +++ b/v7.3.0/output/botcore.site_api.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.site_api.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.site_api.html">v7.3.1</a> </li> diff --git a/v7.3.0/output/botcore.utils.caching.html b/v7.3.0/output/botcore.utils.caching.html index 5931632c..bc3b782d 100644 --- a/v7.3.0/output/botcore.utils.caching.html +++ b/v7.3.0/output/botcore.utils.caching.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.caching.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.caching.html">v7.3.1</a> </li> diff --git a/v7.3.0/output/botcore.utils.channel.html b/v7.3.0/output/botcore.utils.channel.html index fd66e046..471406a3 100644 --- a/v7.3.0/output/botcore.utils.channel.html +++ b/v7.3.0/output/botcore.utils.channel.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.channel.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.channel.html">v7.3.1</a> </li> diff --git a/v7.3.0/output/botcore.utils.html b/v7.3.0/output/botcore.utils.html index 87497bf5..256124f5 100644 --- a/v7.3.0/output/botcore.utils.html +++ b/v7.3.0/output/botcore.utils.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.html">v7.3.1</a> </li> @@ -319,7 +323,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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/botcore/utils/__init__.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/9c0e5a6b0354e48a1def2608370b197d39e9b1e9/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/v7.3.0/output/botcore.utils.interactions.html b/v7.3.0/output/botcore.utils.interactions.html index 9c3e1ff2..66bfe38f 100644 --- a/v7.3.0/output/botcore.utils.interactions.html +++ b/v7.3.0/output/botcore.utils.interactions.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.interactions.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.interactions.html">v7.3.1</a> </li> diff --git a/v7.3.0/output/botcore.utils.logging.html b/v7.3.0/output/botcore.utils.logging.html index d79f14c3..82861843 100644 --- a/v7.3.0/output/botcore.utils.logging.html +++ b/v7.3.0/output/botcore.utils.logging.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.logging.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.logging.html">v7.3.1</a> </li> diff --git a/v7.3.0/output/botcore.utils.members.html b/v7.3.0/output/botcore.utils.members.html index 97741141..ec5a3d45 100644 --- a/v7.3.0/output/botcore.utils.members.html +++ b/v7.3.0/output/botcore.utils.members.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.members.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.members.html">v7.3.1</a> </li> diff --git a/v7.3.0/output/botcore.utils.regex.html b/v7.3.0/output/botcore.utils.regex.html index 009d1467..4b925483 100644 --- a/v7.3.0/output/botcore.utils.regex.html +++ b/v7.3.0/output/botcore.utils.regex.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.regex.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.regex.html">v7.3.1</a> </li> diff --git a/v7.3.0/output/botcore.utils.scheduling.html b/v7.3.0/output/botcore.utils.scheduling.html index 6c8daad8..8f2f5b5f 100644 --- a/v7.3.0/output/botcore.utils.scheduling.html +++ b/v7.3.0/output/botcore.utils.scheduling.html @@ -210,6 +210,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v7.4.0/output/botcore.utils.scheduling.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v7.3.1/output/botcore.utils.scheduling.html">v7.3.1</a> </li> diff --git a/v7.3.0/py-modindex.html b/v7.3.0/py-modindex.html index 1e1fbcd9..ada05bbd 100644 --- a/v7.3.0/py-modindex.html +++ b/v7.3.0/py-modindex.html @@ -208,6 +208,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v7.4.0/index.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v7.3.1/index.html">v7.3.1</a> </li> diff --git a/v7.3.0/search.html b/v7.3.0/search.html index a7483c68..29ae49fc 100644 --- a/v7.3.0/search.html +++ b/v7.3.0/search.html @@ -207,6 +207,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v7.4.0/index.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v7.3.1/index.html">v7.3.1</a> </li> diff --git a/v7.3.0/versions.html b/v7.3.0/versions.html index 3b878ccc..007637ba 100644 --- a/v7.3.0/versions.html +++ b/v7.3.0/versions.html @@ -209,6 +209,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v7.4.0/index.html">v7.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v7.3.1/index.html">v7.3.1</a> </li> @@ -314,6 +318,12 @@ </li> <li> + <a class="reference internal" href="../v7.4.0/index.html">v7.4.0</a> + + + </li> + + <li> <a class="reference internal" href="../v7.3.1/index.html">v7.3.1</a> |