diff options
author | 2022-04-20 22:26:13 +0000 | |
---|---|---|
committer | 2022-04-20 22:26:13 +0000 | |
commit | 166de84ed921ee41a1aa81131fb08074f9d54a44 (patch) | |
tree | 91236a3f0be12cb3c1bca6a673d880b328a03606 /output/botcore.utils.html | |
parent | Deploying to docs from @ python-discord/bot-core@98a5cc0f48aa58072f78e3faee90... (diff) |
Deploying to docs from @ python-discord/bot-core@7d4784edae5e70322545e9523a945ed7a849d5bb 🚀
Diffstat (limited to 'output/botcore.utils.html')
-rw-r--r-- | output/botcore.utils.html | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/output/botcore.utils.html b/output/botcore.utils.html index 55713223..81be8fe4 100644 --- a/output/botcore.utils.html +++ b/output/botcore.utils.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="caching" href="botcore.utils.caching.html" /><link rel="prev" title="Exts" href="botcore.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-4.5.0, furo 2022.04.07"/> - <title>Utils - Bot Core v6.0.0</title> + <title>Utils - Bot Core v6.1.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -126,7 +126,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v6.0.0</div></a> + <a href="../index.html"><div class="brand">Bot Core v6.1.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -152,7 +152,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 v6.0.0</span> + <span class="sidebar-brand-text">Bot Core v6.1.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"> @@ -218,7 +218,7 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.apply_monkey_patches"> -<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/98a5cc0f48aa58072f78e3faee90c0b0510f1723/botcore/utils/__init__.py#L6-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/7d4784edae5e70322545e9523a945ed7a849d5bb/botcore/utils/__init__.py#L7-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt> <dd><p>Applies all common monkey patches for our bots.</p> <dl> <dt>Patches <a class="reference external" href="https://discordpy.readthedocs.io/en/master/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Command</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/master/ext/commands/api.html#discord.ext.commands.Group" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Group</span></code></a> to support root aliases.</dt><dd><p>A <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code> keyword argument is added to these two objects, which is a sequence of alias names @@ -234,6 +234,22 @@ that will act as top-level groups rather than being aliases of the command’s g </dd> </dl> </dd></dl> +<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/7d4784edae5e70322545e9523a945ed7a849d5bb/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> +<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</dt> +<dd class="field-odd"><p><strong>name</strong> (<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 module name to unqualify.</p> +</dd> +<dt class="field-even">Return type</dt> +<dd class="field-even"><p><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></p> +</dd> +<dt class="field-odd">Returns</dt> +<dd class="field-odd"><p>The unqualified module name.</p> +</dd> +</dl> +</dd></dl> <section id="submodules"> <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">#</a></h2> <div class="toctree-wrapper compound"> |