diff options
| author | 2022-10-26 09:23:46 +0000 | |
|---|---|---|
| committer | 2022-10-26 09:23:46 +0000 | |
| commit | 273d4529153676a294eaea1465cf67530fae80ce (patch) | |
| tree | 9f4ff898efb1ee9b00169aa93d4ee978153a31e4 /v8.3.0-beta/output/botcore.html | |
| parent | Deploying to docs from @ python-discord/bot-core@c7a6ddd00eb371759d837aa75fa3... (diff) | |
Deploying to docs from @ python-discord/bot-core@6ae78684ee0e61d8a6ad8bb779ea30f2e5294d0d 🚀
Diffstat (limited to 'v8.3.0-beta/output/botcore.html')
| -rw-r--r-- | v8.3.0-beta/output/botcore.html | 734 | 
1 files changed, 734 insertions, 0 deletions
| diff --git a/v8.3.0-beta/output/botcore.html b/v8.3.0-beta/output/botcore.html new file mode 100644 index 00000000..72fcce42 --- /dev/null +++ b/v8.3.0-beta/output/botcore.html @@ -0,0 +1,734 @@ +<!doctype html> +<html class="no-js" lang="en"> +  <head><meta charset="utf-8"/> +    <meta name="viewport" content="width=device-width,initial-scale=1"/> +    <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> +<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Exts" href="botcore.exts.html" /><link rel="prev" title="Bot Core Project Documentation" href="../index.html" /> + +    <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.2.2, furo 2022.09.15"/> +        <title>Botcore - Bot Core v8.3.0-beta</title> +      <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> +    <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" /> +    <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> +    <link rel="stylesheet" type="text/css" href="../_static/logo.css" /> +    <link rel="stylesheet" type="text/css" href="../_static/changelog.css" /> +    <link rel="stylesheet" type="text/css" href="../_static/index.css" /> +     +     + + +<style> +  body { +    --color-code-background: #f8f8f8; +  --color-code-foreground: black; +  --color-api-name: var(--color-link); +   +  } +  @media not print { +    body[data-theme="dark"] { +      --color-code-background: #202020; +  --color-code-foreground: #d0d0d0; +   +    } +    @media (prefers-color-scheme: dark) { +      body:not([data-theme="light"]) { +        --color-code-background: #202020; +  --color-code-foreground: #d0d0d0; +   +      } +    } +  } +</style></head> +  <body> +     +    <script> +      document.body.dataset.theme = localStorage.getItem("theme") || "auto"; +    </script> +     + +<svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> +  <symbol id="svg-toc" viewBox="0 0 24 24"> +    <title>Contents</title> +    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> +      <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> +    </svg> +  </symbol> +  <symbol id="svg-menu" viewBox="0 0 24 24"> +    <title>Menu</title> +    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" +      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> +      <line x1="3" y1="12" x2="21" y2="12"></line> +      <line x1="3" y1="6" x2="21" y2="6"></line> +      <line x1="3" y1="18" x2="21" y2="18"></line> +    </svg> +  </symbol> +  <symbol id="svg-arrow-right" viewBox="0 0 24 24"> +    <title>Expand</title> +    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" +      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> +      <polyline points="9 18 15 12 9 6"></polyline> +    </svg> +  </symbol> +  <symbol id="svg-sun" viewBox="0 0 24 24"> +    <title>Light mode</title> +    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" +      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> +      <circle cx="12" cy="12" r="5"></circle> +      <line x1="12" y1="1" x2="12" y2="3"></line> +      <line x1="12" y1="21" x2="12" y2="23"></line> +      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> +      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> +      <line x1="1" y1="12" x2="3" y2="12"></line> +      <line x1="21" y1="12" x2="23" y2="12"></line> +      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> +      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> +    </svg> +  </symbol> +  <symbol id="svg-moon" viewBox="0 0 24 24"> +    <title>Dark mode</title> +    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" +      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> +      <path stroke="none" d="M0 0h24v24H0z" fill="none" /> +      <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> +    </svg> +  </symbol> +  <symbol id="svg-sun-half" viewBox="0 0 24 24"> +    <title>Auto light/dark mode</title> +    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" +      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> +      <path stroke="none" d="M0 0h24v24H0z" fill="none"/> +      <circle cx="12" cy="12" r="9" /> +      <path d="M13 12h5" /> +      <path d="M13 15h4" /> +      <path d="M13 18h1" /> +      <path d="M13 9h4" /> +      <path d="M13 6h1" /> +    </svg> +  </symbol> +</svg> + +<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> +<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> +<label class="overlay sidebar-overlay" for="__navigation"> +  <div class="visually-hidden">Hide navigation sidebar</div> +</label> +<label class="overlay toc-overlay" for="__toc"> +  <div class="visually-hidden">Hide table of contents sidebar</div> +</label> + + + +<div class="page"> +  <header class="mobile-header"> +    <div class="header-left"> +      <label class="nav-overlay-icon" for="__navigation"> +        <div class="visually-hidden">Toggle site navigation sidebar</div> +        <i class="icon"><svg><use href="#svg-menu"></use></svg></i> +      </label> +    </div> +    <div class="header-center"> +      <a href="../index.html"><div class="brand">Bot Core v8.3.0-beta</div></a> +    </div> +    <div class="header-right"> +      <div class="theme-toggle-container theme-toggle-header"> +        <button class="theme-toggle"> +          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> +          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> +          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> +          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> +        </button> +      </div> +      <label class="toc-overlay-icon toc-header-icon" for="__toc"> +        <div class="visually-hidden">Toggle table of contents sidebar</div> +        <i class="icon"><svg><use href="#svg-toc"></use></svg></i> +      </label> +    </div> +  </header> +  <aside class="sidebar-drawer"> +    <div class="sidebar-container"> +       +      <div class="sidebar-sticky"><a class="sidebar-brand centered" href="../index.html"> +   +  <div class="sidebar-logo-container"> +    <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> +  </div> +   +  <span class="sidebar-brand-text">Bot Core v8.3.0-beta</span> +   +</a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> +  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> +  <input type="hidden" name="check_keywords" value="yes"> +  <input type="hidden" name="area" value="default"> +</form> +<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> +    <p class="caption" role="heading"><span class="caption-text">Modules:</span></p> +<ul class="current"> +<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Botcore</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l2"><a class="reference internal" href="botcore.exts.html">Exts</a></li> +<li class="toctree-l2 has-children"><a class="reference internal" href="botcore.utils.html">Utils</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.interactions.html">interactions</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.logging.html">logging</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.members.html">members</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.regex.html">regex</a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html">scheduling</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="botcore.async_stats.html">async_stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="botcore.site_api.html">site_api</a></li> +</ul> +</li> +</ul> +<p class="caption" role="heading"><span class="caption-text">Other:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Local Development & Testing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li> +</ul> + + +     +     +    <ul> +        <li class="toctree-l1 has-children "> +             +            <a class="reference internal" href="../versions.html">Versions</a> +            <input  class="toctree-checkbox" id="toctree-checkbox-versions" name="toctree-checkbox-versions" role="switch" type="checkbox"> +            <label for="toctree-checkbox-versions"> +                <div class="visually-hidden">Toggle child pages in navigation</div> +                <i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i> +            </label> +             + +            <ul> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../main/output/botcore.html">main</a> +                    </li> +                 +                    <li class="toctree-l2 current-page"> +                        <a class="version_link reference internal" href="botcore.html">v8.3.0-beta</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v8.2.1/output/botcore.html">v8.2.1</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v8.2.0/output/botcore.html">v8.2.0</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v8.1.0/output/botcore.html">v8.1.0</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.html">v8.0.0-beta.4</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v8.0.0-beta.3/output/botcore.html">v8.0.0-beta.3</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v8.0.0-beta.2/output/botcore.html">v8.0.0-beta.2</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v8.0.0-beta.1/output/botcore.html">v8.0.0-beta.1</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v8.0.0/output/botcore.html">v8.0.0</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v7.5.0/output/botcore.html">v7.5.0</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v7.4.0-beta1/output/botcore.html">v7.4.0-beta1</a> +                    </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> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v7.3.0/output/botcore.html">v7.3.0</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v7.2.2/output/botcore.html">v7.2.2</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v7.2.1/output/botcore.html">v7.2.1</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v7.2.0/output/botcore.html">v7.2.0</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v7.1.3/output/botcore.html">v7.1.3</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v7.1.2/output/botcore.html">v7.1.2</a> +                    </li> +                 +                    <li class="toctree-l2 "> +                        <a class="version_link reference internal" href="../../v7.1.1/output/botcore.html">v7.1.1</a> +                    </li> +                 + +                <script> +                    // Make sure we keep any hyperlinked resources when switching version +                    function updateHash() { +                        for (let tag of document.getElementsByClassName("version_link")) { +                            // Extract the original URL +                            let destination = tag.getAttribute("href"); +                            if (destination.indexOf("#") !== -1) { +                                destination = destination.slice(0, destination.indexOf("#")); +                            } + +                            // Update the url with the current hash +                            tag.setAttribute("href", destination + document.location.hash); +                        } +                    } + +                    updateHash(); +                    addEventListener("hashchange", _ => { updateHash() }); +                </script> +            </ul> +        </li> +    </ul> +     +</div> +</div> + +      </div> +       +    </div> +  </aside> +  <div class="main"> +    <div class="content"> +      <div class="article-container"> +        <a href="#" class="back-to-top muted-link"> +          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> +            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> +          </svg> +          <span>Back to top</span> +        </a> +        <div class="content-icon-container"> +          <div class="theme-toggle-container theme-toggle-content"> +            <button class="theme-toggle"> +              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> +              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> +              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> +              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> +            </button> +          </div> +          <label class="toc-overlay-icon toc-content-icon" for="__toc"> +            <div class="visually-hidden">Toggle table of contents sidebar</div> +            <i class="icon"><svg><use href="#svg-toc"></use></svg></i> +          </label> +        </div> +        <article role="main"> +          <section id="module-botcore"> +<span id="botcore"></span><h1>Botcore<a class="headerlink" href="#module-botcore" title="Permalink to this heading">#</a></h1> +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/botcore/_bot.py#L36-L289"><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.1.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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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</dt> +<dd class="field-odd"><ul class="simple"> +<li><p><strong>guild_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – The ID of the guild used for <a class="reference internal" href="#botcore.BotBase.wait_until_guild_available" title="botcore.BotBase.wait_until_guild_available"><code class="xref py py-func docutils literal notranslate"><span class="pre">wait_until_guild_available()</span></code></a>.</p></li> +<li><p><strong>allowed_roles</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>) – A list of role IDs that the bot is allowed to mention.</p></li> +<li><p><strong>http_session</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.8)"><em>aiohttp.ClientSession</em></a>) – The session to use for the bot.</p></li> +<li><p><strong>redis_session</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<code class="xref py py-class docutils literal notranslate"><span class="pre">RedisSession</span></code>]) – The <a class="reference external" href="https://github.com/SebastiaanZ/async-rediscache#creating-a-redissession">async_rediscache.RedisSession</a> to use for the bot.</p></li> +<li><p><strong>api_client</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIClient</span></code></a>]) – The <a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">botcore.site_api.APIClient</span></code></a> instance to use for the bot.</p></li> +<li><p><strong>statsd_url</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]) – The URL of the statsd server to use for the bot. If not given, +a dummy statsd client will be created.</p></li> +</ul> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/botcore/_bot.py#L258-L289"><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</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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"> +<dt class="field-odd">Return type</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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> +<dl class="field-list simple"> +<dt class="field-odd">Return type</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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> +<dl class="field-list simple"> +<dt class="field-odd">Return type</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a>]</p> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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> +and <a class="reference internal" href="#botcore.BotBase.ping_services" title="botcore.BotBase.ping_services"><code class="xref py py-func docutils literal notranslate"><span class="pre">ping_services()</span></code></a>.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +</dd> +</dl> +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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> +<dl class="field-list simple"> +<dt class="field-odd">Return type</dt> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +</dd> +</dl> +</dd></dl> + +</dd></dl> + +<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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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/67ae5cb94dc726bee7996d9a7f8d4b33f0677583/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> + +<section id="subpackages"> +<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading">#</a></h2> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="botcore.exts.html">Exts</a></li> +<li class="toctree-l1"><a class="reference internal" href="botcore.utils.html">Utils</a><ul> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.html#botcore.utils.apply_monkey_patches"><code class="docutils literal notranslate"><span class="pre">apply_monkey_patches()</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.html#botcore.utils.unqualify"><code class="docutils literal notranslate"><span class="pre">unqualify()</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="botcore.utils.html#submodules">Submodules</a><ul> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.caching.html">caching</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.caching.html#botcore.utils.caching.AsyncCache"><code class="docutils literal notranslate"><span class="pre">AsyncCache</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.channel.html">channel</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.channel.html#botcore.utils.channel.get_or_fetch_channel"><code class="docutils literal notranslate"><span class="pre">get_or_fetch_channel()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.channel.html#botcore.utils.channel.is_in_category"><code class="docutils literal notranslate"><span class="pre">is_in_category()</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.commands.html">commands</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.commands.html#botcore.utils.commands.clean_text_or_reply"><code class="docutils literal notranslate"><span class="pre">clean_text_or_reply()</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.cooldown.html">cooldown</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.CommandOnCooldown"><code class="docutils literal notranslate"><span class="pre">CommandOnCooldown</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.P"><code class="docutils literal notranslate"><span class="pre">P</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.R"><code class="docutils literal notranslate"><span class="pre">R</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.cooldown.html#botcore.utils.cooldown.block_duplicate_invocations"><code class="docutils literal notranslate"><span class="pre">block_duplicate_invocations()</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.function.html">function</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.function.html#botcore.utils.function.GlobalNameConflictError"><code class="docutils literal notranslate"><span class="pre">GlobalNameConflictError</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.function.html#botcore.utils.function.command_wraps"><code class="docutils literal notranslate"><span class="pre">command_wraps()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.function.html#botcore.utils.function.update_wrapper_globals"><code class="docutils literal notranslate"><span class="pre">update_wrapper_globals()</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.interactions.html">interactions</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.interactions.html#botcore.utils.interactions.DeleteMessageButton"><code class="docutils literal notranslate"><span class="pre">DeleteMessageButton</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.interactions.html#botcore.utils.interactions.ViewWithUserAndRoleCheck"><code class="docutils literal notranslate"><span class="pre">ViewWithUserAndRoleCheck</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.logging.html">logging</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.logging.html#botcore.utils.logging.CustomLogger"><code class="docutils literal notranslate"><span class="pre">CustomLogger</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.logging.html#botcore.utils.logging.get_logger"><code class="docutils literal notranslate"><span class="pre">get_logger()</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.members.html">members</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.members.html#botcore.utils.members.get_or_fetch_member"><code class="docutils literal notranslate"><span class="pre">get_or_fetch_member()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.members.html#botcore.utils.members.handle_role_change"><code class="docutils literal notranslate"><span class="pre">handle_role_change()</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.regex.html">regex</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.regex.html#botcore.utils.regex.DISCORD_INVITE"><code class="docutils literal notranslate"><span class="pre">DISCORD_INVITE</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.regex.html#botcore.utils.regex.FORMATTED_CODE_REGEX"><code class="docutils literal notranslate"><span class="pre">FORMATTED_CODE_REGEX</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.regex.html#botcore.utils.regex.RAW_CODE_REGEX"><code class="docutils literal notranslate"><span class="pre">RAW_CODE_REGEX</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="botcore.utils.scheduling.html">scheduling</a><ul> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.Scheduler"><code class="docutils literal notranslate"><span class="pre">Scheduler</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="botcore.utils.scheduling.html#botcore.utils.scheduling.create_task"><code class="docutils literal notranslate"><span class="pre">create_task()</span></code></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</section> +<section id="submodules"> +<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading">#</a></h2> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="botcore.async_stats.html">async_stats</a><ul> +<li class="toctree-l2"><a class="reference internal" href="botcore.async_stats.html#botcore.async_stats.AsyncStatsClient"><code class="docutils literal notranslate"><span class="pre">AsyncStatsClient</span></code></a><ul> +<li class="toctree-l3"><a class="reference internal" href="botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.__init__"><code class="docutils literal notranslate"><span class="pre">AsyncStatsClient.__init__()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.create_socket"><code class="docutils literal notranslate"><span class="pre">AsyncStatsClient.create_socket()</span></code></a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="botcore.site_api.html">site_api</a><ul> +<li class="toctree-l2"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient"><code class="docutils literal notranslate"><span class="pre">APIClient</span></code></a><ul> +<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.__init__"><code class="docutils literal notranslate"><span class="pre">APIClient.__init__()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.close"><code class="docutils literal notranslate"><span class="pre">APIClient.close()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.delete"><code class="docutils literal notranslate"><span class="pre">APIClient.delete()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.get"><code class="docutils literal notranslate"><span class="pre">APIClient.get()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.maybe_raise_for_status"><code class="docutils literal notranslate"><span class="pre">APIClient.maybe_raise_for_status()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.patch"><code class="docutils literal notranslate"><span class="pre">APIClient.patch()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.post"><code class="docutils literal notranslate"><span class="pre">APIClient.post()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.put"><code class="docutils literal notranslate"><span class="pre">APIClient.put()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient.request"><code class="docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.ResponseCodeError"><code class="docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a><ul> +<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.ResponseCodeError.__init__"><code class="docutils literal notranslate"><span class="pre">ResponseCodeError.__init__()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="botcore.site_api.html#botcore.site_api.ResponseCodeError.__str__"><code class="docutils literal notranslate"><span class="pre">ResponseCodeError.__str__()</span></code></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</section> +</section> + +        </article> +      </div> +      <footer> +         +        <div class="related-pages"> +          <a class="next-page" href="botcore.exts.html"> +              <div class="page-info"> +                <div class="context"> +                  <span>Next</span> +                </div> +                <div class="title">Exts</div> +              </div> +              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> +            </a> +          <a class="prev-page" href="../index.html"> +              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> +              <div class="page-info"> +                <div class="context"> +                  <span>Previous</span> +                </div> +                 +                <div class="title">Home</div> +                 +              </div> +            </a> +        </div> +        <div class="bottom-of-page"> +          <div class="left-details"> +            <div class="copyright"> +                Copyright © 2021, Python Discord +            </div> +            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s +             +            <a href="https://github.com/pradyunsg/furo">Furo</a> +             +          </div> +          <div class="right-details"> +            <div class="icons"> +               +            </div> +          </div> +        </div> +         +      </footer> +    </div> +    <aside class="toc-drawer"> +       +       +      <div class="toc-sticky toc-scroll"> +        <div class="toc-title-container"> +          <span class="toc-title"> +            On this page +          </span> +        </div> +        <div class="toc-tree-container"> +          <div class="toc-tree"> +            <ul> +<li><a class="reference internal" href="#">Botcore</a><ul> +<li><a class="reference internal" href="#botcore.BotBase"><code class="docutils literal notranslate"><span class="pre">BotBase</span></code></a><ul> +<li><a class="reference internal" href="#botcore.BotBase.__init__"><code class="docutils literal notranslate"><span class="pre">BotBase.__init__()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.add_cog"><code class="docutils literal notranslate"><span class="pre">BotBase.add_cog()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.add_command"><code class="docutils literal notranslate"><span class="pre">BotBase.add_command()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.clear"><code class="docutils literal notranslate"><span class="pre">BotBase.clear()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.close"><code class="docutils literal notranslate"><span class="pre">BotBase.close()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.load_extensions"><code class="docutils literal notranslate"><span class="pre">BotBase.load_extensions()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.log_to_dev_log"><code class="docutils literal notranslate"><span class="pre">BotBase.log_to_dev_log()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.on_guild_available"><code class="docutils literal notranslate"><span class="pre">BotBase.on_guild_available()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.on_guild_unavailable"><code class="docutils literal notranslate"><span class="pre">BotBase.on_guild_unavailable()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.ping_services"><code class="docutils literal notranslate"><span class="pre">BotBase.ping_services()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.remove_command"><code class="docutils literal notranslate"><span class="pre">BotBase.remove_command()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.setup_hook"><code class="docutils literal notranslate"><span class="pre">BotBase.setup_hook()</span></code></a></li> +<li><a class="reference internal" href="#botcore.BotBase.wait_until_guild_available"><code class="docutils literal notranslate"><span class="pre">BotBase.wait_until_guild_available()</span></code></a></li> +</ul> +</li> +<li><a class="reference internal" href="#botcore.StartupError"><code class="docutils literal notranslate"><span class="pre">StartupError</span></code></a><ul> +<li><a class="reference internal" href="#botcore.StartupError.__init__"><code class="docutils literal notranslate"><span class="pre">StartupError.__init__()</span></code></a></li> +</ul> +</li> +<li><a class="reference internal" href="#subpackages">Subpackages</a></li> +<li><a class="reference internal" href="#submodules">Submodules</a></li> +</ul> +</li> +</ul> + +          </div> +        </div> +      </div> +       +       +    </aside> +  </div> +</div><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> +    <script src="../_static/jquery.js"></script> +    <script src="../_static/underscore.js"></script> +    <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script> +    <script src="../_static/doctools.js"></script> +    <script src="../_static/sphinx_highlight.js"></script> +    <script src="../_static/scripts/furo.js"></script> +    <script src="../_static/changelog.js"></script> +    </body> +</html>
\ No newline at end of file | 
