aboutsummaryrefslogtreecommitdiffstats
path: root/output/botcore.utils.regex.html
diff options
context:
space:
mode:
authorGravatar HassanAbouelela <[email protected]>2022-05-10 19:23:22 +0000
committerGravatar HassanAbouelela <[email protected]>2022-05-10 19:23:22 +0000
commitbf55b5820b78d57b72249d8f288c7a9fd28d53b0 (patch)
tree16d89224168a56368652f084706a94d711c75be7 /output/botcore.utils.regex.html
parentDeploying to docs from @ python-discord/bot-core@a349c20a08ab2e15a9538f9e42b7... (diff)
Deploying to docs from @ python-discord/bot-core@7eef69c7be762f0b2becf4e623c11b1507756966 🚀
Diffstat (limited to 'output/botcore.utils.regex.html')
-rw-r--r--output/botcore.utils.regex.html12
1 files changed, 9 insertions, 3 deletions
diff --git a/output/botcore.utils.regex.html b/output/botcore.utils.regex.html
index 934499af..e682154f 100644
--- a/output/botcore.utils.regex.html
+++ b/output/botcore.utils.regex.html
@@ -218,21 +218,27 @@
<p>Common regular expressions.</p>
<dl class="py data">
<dt class="sig sig-object py" id="botcore.utils.regex.DISCORD_INVITE">
-<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a349c20a08ab2e15a9538f9e42b77df2c924511f/botcore/utils/regex.py#L5-L16"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.DISCORD_INVITE" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/7eef69c7be762f0b2becf4e623c11b1507756966/botcore/utils/regex.py#L5-L16"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.DISCORD_INVITE" title="Permalink to this definition">#</a></dt>
<dd><p>Regex for Discord server invites.</p>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in
+any HTTP requests or similar. Please ensure you sanitise the output using something
+such as <a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote" title="(in Python v3.10)"><code class="xref py py-func docutils literal notranslate"><span class="pre">urllib.parse.quote()</span></code></a>.</p>
+</div>
<dl class="field-list simple">
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="botcore.utils.regex.FORMATTED_CODE_REGEX">
-<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a349c20a08ab2e15a9538f9e42b77df2c924511f/botcore/utils/regex.py#L23-L31"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.FORMATTED_CODE_REGEX" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/7eef69c7be762f0b2becf4e623c11b1507756966/botcore/utils/regex.py#L28-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.FORMATTED_CODE_REGEX" title="Permalink to this definition">#</a></dt>
<dd><p>Regex for formatted code, using Discord’s code blocks.</p>
<dl class="field-list simple">
</dl>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="botcore.utils.regex.RAW_CODE_REGEX">
-<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/a349c20a08ab2e15a9538f9e42b77df2c924511f/botcore/utils/regex.py#L38-L43"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.RAW_CODE_REGEX" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/7eef69c7be762f0b2becf4e623c11b1507756966/botcore/utils/regex.py#L43-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.RAW_CODE_REGEX" title="Permalink to this definition">#</a></dt>
<dd><p>Regex for raw code, <em>not</em> using Discord’s code blocks.</p>
<dl class="field-list simple">
</dl>