aboutsummaryrefslogtreecommitdiffstats
path: root/main/output/pydis_core.utils.html
diff options
context:
space:
mode:
authorGravatar ChrisLovering <[email protected]>2022-11-10 21:42:51 +0000
committerGravatar ChrisLovering <[email protected]>2022-11-10 21:42:51 +0000
commiteaad5d928c254438f70f1ac7634a418d4a686fad (patch)
tree94c9ae5dadd1d5c9a1d3dd1e67713db414403cff /main/output/pydis_core.utils.html
parentDeploying to docs from @ python-discord/bot-core@3f55e7149a3197b7fa41fcf7dc7d... (diff)
Deploying to docs from @ python-discord/bot-core@a6760a64bcec5ba77709492ba33b6bfba1f58e84 🚀
Diffstat (limited to 'main/output/pydis_core.utils.html')
-rw-r--r--main/output/pydis_core.utils.html28
1 files changed, 16 insertions, 12 deletions
diff --git a/main/output/pydis_core.utils.html b/main/output/pydis_core.utils.html
index e079175c..ac94ea8e 100644
--- a/main/output/pydis_core.utils.html
+++ b/main/output/pydis_core.utils.html
@@ -3,10 +3,10 @@
<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.19: https://docutils.sourceforge.io/" />
-<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="caching" href="pydis_core.utils.caching.html" /><link rel="prev" title="Pydis_Core Exts" href="pydis_core.exts.html" />
+<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="caching" href="pydis_core.utils.caching.html" /><link rel="prev" title="Exts" href="pydis_core.exts.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>Pydis_Core Utils - Bot Core Latest (9.0.0)</title>
+ <title>Utils - Pydis Core Latest (9.0.0)</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" />
@@ -127,7 +127,7 @@
</label>
</div>
<div class="header-center">
- <a href="../index.html"><div class="brand">Bot Core Latest (9.0.0)</div></a>
+ <a href="../index.html"><div class="brand">Pydis Core Latest (9.0.0)</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
@@ -153,7 +153,7 @@
<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 Latest (9.0.0)</span>
+ <span class="sidebar-brand-text">Pydis Core Latest (9.0.0)</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">
@@ -163,9 +163,9 @@
<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"><a class="reference internal" href="pydis_core.html">Pydis_Core</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 class="current">
-<li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Pydis_Core Exts</a></li>
-<li class="toctree-l2 current has-children current-page"><a class="current reference internal" href="#">Pydis_Core Utils</a><input checked="" 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-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</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 class="current">
+<li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li>
+<li class="toctree-l2 current has-children current-page"><a class="current reference internal" href="#">Utils</a><input checked="" 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="pydis_core.utils.caching.html">caching</a></li>
<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li>
<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li>
@@ -210,6 +210,10 @@
</li>
<li class="toctree-l2 ">
+ <a class="version_link reference internal" href="../../v9.0.0/output/pydis_core.utils.html">v9.0.0</a>
+ </li>
+
+ <li class="toctree-l2 ">
<a class="version_link reference internal" href="../../v8.3.0-beta/index.html">v8.3.0-beta</a>
</li>
@@ -344,11 +348,11 @@
</div>
<article role="main">
<section id="module-pydis_core.utils">
-<span id="pydis-core-utils"></span><h1>Pydis_Core Utils<a class="headerlink" href="#module-pydis_core.utils" title="Permalink to this heading">#</a></h1>
+<span id="utils"></span><h1>Utils<a class="headerlink" href="#module-pydis_core.utils" title="Permalink to this heading">#</a></h1>
<p>Useful utilities and tools for Discord bot development.</p>
<dl class="py function">
<dt class="sig sig-object py" id="pydis_core.utils.apply_monkey_patches">
-<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/3f55e7149a3197b7fa41fcf7dc7df47a3a209cfd/pydis_core/utils/__init__.py#L19-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a6760a64bcec5ba77709492ba33b6bfba1f58e84/pydis_core/utils/__init__.py#L19-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt>
<dd><p>Applies all common monkey patches for our bots.</p>
<dl>
<dt>Patches <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.1.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Command</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Group" title="(in discord.py v2.1.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Group</span></code></a> to support root aliases.</dt><dd><p>A <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code> keyword argument is added to these two objects, which is a sequence of alias names
@@ -367,7 +371,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="pydis_core.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/3f55e7149a3197b7fa41fcf7dc7df47a3a209cfd/pydis_core/utils/_extensions.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.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/a6760a64bcec5ba77709492ba33b6bfba1f58e84/pydis_core/utils/_extensions.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.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>
@@ -494,7 +498,7 @@ that will act as top-level groups rather than being aliases of the command’s g
<span>Previous</span>
</div>
- <div class="title">Pydis_Core Exts</div>
+ <div class="title">Exts</div>
</div>
</a>
@@ -530,7 +534,7 @@ that will act as top-level groups rather than being aliases of the command’s g
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
-<li><a class="reference internal" href="#">Pydis_Core Utils</a><ul>
+<li><a class="reference internal" href="#">Utils</a><ul>
<li><a class="reference internal" href="#pydis_core.utils.apply_monkey_patches"><code class="docutils literal notranslate"><span class="pre">apply_monkey_patches()</span></code></a></li>
<li><a class="reference internal" href="#pydis_core.utils.unqualify"><code class="docutils literal notranslate"><span class="pre">unqualify()</span></code></a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>