mirror/ascode
1
1
Fork 0
mirror of https://github.com/mcuadros/ascode synced 2025-11-16 05:17:13 +01:00
Code Issues
gh-pages
ascode/docs/reference/re/index.html

24 lines
11 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html><html lang=en><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="ie=edge"><title>re - AsCode - Terraform Alternative Syntax</title><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=https://ascode.run/images/favicon.png><link rel=stylesheet href=/css/style.min.df49831c6872564dff31a5f0978a9571f2c8110b513d4b3b1fc8ead41dcdc9f0.css></head><body class="page page-default-single"><div id=main-menu-mobile class=main-menu-mobile><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><div class=wrapper><div class=header><div class=container><div class=logo><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div class=logo-mobile><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div id=main-menu class=main-menu><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><button id=toggle-main-menu-mobile class="hamburger hamburger--slider" type=button>
<span class=hamburger-box><span class=hamburger-inner></span></span></button></div></div><div class="main container pt-2 pt-md-6 pb-3 pb-md-6"><div class=row><div class="col-12 col-md-3 mb-3"><div class=sidebar><div class=docs-menu><h4><a href=/docs/reference/>API Reference</a></h4><ul><li><a href=/docs/reference/types/>built-in</a></li><li><a href=/docs/reference/docker/>docker</a></li><li><a href=/docs/reference/base64/>encoding/base64</a></li><li><a href=/docs/reference/csv/>encoding/csv</a></li><li><a href=/docs/reference/json/>encoding/json</a></li><li><a href=/docs/reference/yaml/>encoding/yaml</a></li><li><a href=/docs/reference/http/>http</a></li><li><a href=/docs/reference/math/>math</a></li><li><a href=/docs/reference/os/>os</a></li><li><a href=/docs/reference/filepath/>path/filepath</a></li><li><a class=active href=/docs/reference/re/>re</a></li><li><a href=/docs/reference/time/>time</a></li><li><a href=/docs/reference/url/>url</a></li></ul></div><div style=font-size:90%;margin-top:40px><a href=/docs/>« Documentation</a></div></div></div><div class="col-12 col-md-9"><h1 class=title>re</h1><div class=content><h2 id=index>Index</h2><div class=toc><nav id=TableOfContents><ul><li><a href=#overview>Overview</a></li><li><a href=#functions>Functions</a><ul><li><a href=#def-bcompileb>def <b>compile</b></a></li><li><a href=#def-bfindallb>def <b>findall</b></a></li><li><a href=#def-bmatchb>def <b>match</b></a></li><li><a href=#def-bsplitb>def <b>split</b></a></li><li><a href=#def-bsubb>def <b>sub</b></a></li></ul></li><li><a href=#types>Types</a><ul><li><a href=#type-bpatternb>type <b>Pattern</b></a></li></ul></li></ul></nav></div><h2 id=overview>Overview</h2><p>re defines regular expression functions, it&rsquo;s intended to be a drop-in
subset of python&rsquo;s re module for starlark: <a href=https://docs.python.org/3/library/re.html>https://docs.python.org/3/library/re.html</a></p><h2 id=functions>Functions</h2><h3 id=def-bcompileb>def <b>compile</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>compile</span><span class=p>(</span><span class=nx>pattern</span><span class=p>)</span> <span class=nx>Pattern</span>
</code></pre></div><p>Compile a regular expression pattern into a regular expression object, which
can be used for matching using its match(), search() and other methods.</p><h6 id=arguments>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>pattern</code></td><td><code>string</code></td><td>regular expression pattern string</td></tr></tbody></table><h3 id=def-bfindallb>def <b>findall</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>findall</span><span class=p>(</span><span class=nx>pattern</span><span class=p>,</span> <span class=nx>text</span><span class=p>,</span> <span class=nx>flags</span><span class=p>=</span><span class=mi>0</span><span class=p>)</span>
</code></pre></div><p>Returns all non-overlapping matches of pattern in string, as a list of strings.
The string is scanned left-to-right, and matches are returned in the order found.
If one or more groups are present in the pattern, return a list of groups;
this will be a list of tuples if the pattern has more than one group.
Empty matches are included in the result.</p><h6 id=arguments-1>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>pattern</code></td><td><code>string</code></td><td>regular expression pattern string</td></tr><tr><td><code>text</code></td><td><code>string</code></td><td>string to find within</td></tr><tr><td><code>flags</code></td><td><code>int</code></td><td>integer flags to control regex behaviour. reserved for future use</td></tr></tbody></table><h3 id=def-bmatchb>def <b>match</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>match</span><span class=p>(</span><span class=nx>pattern</span><span class=p>,</span> <span class=kt>string</span><span class=p>,</span> <span class=nx>flags</span><span class=p>=</span><span class=mi>0</span><span class=p>)</span>
</code></pre></div><p>If zero or more characters at the beginning of string match the regular expression pattern,
return a corresponding match string tuple. Return None if the string does not match the pattern</p><h6 id=arguments-2>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>pattern</code></td><td><code>string</code></td><td>regular expression pattern string</td></tr><tr><td><code>string</code></td><td><code>string</code></td><td>input string to match</td></tr></tbody></table><h3 id=def-bsplitb>def <b>split</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>split</span><span class=p>(</span><span class=nx>pattern</span><span class=p>,</span> <span class=nx>text</span><span class=p>,</span> <span class=nx>maxsplit</span><span class=p>=</span><span class=mi>0</span><span class=p>,</span> <span class=nx>flags</span><span class=p>=</span><span class=mi>0</span><span class=p>)</span>
</code></pre></div><p>Split text by the occurrences of pattern. If capturing parentheses are used in pattern,
then the text of all groups in the pattern are also returned as part of the resulting list.
If maxsplit is nonzero, at most maxsplit splits occur, and the remainder of the string
is returned as the final element of the list.</p><h6 id=arguments-3>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>pattern</code></td><td><code>string</code></td><td>regular expression pattern string</td></tr><tr><td><code>text</code></td><td><code>string</code></td><td>input string to split</td></tr><tr><td><code>maxsplit</code></td><td><code>int</code></td><td>maximum number of splits to make. default 0 splits all matches</td></tr><tr><td><code>flags</code></td><td><code>int</code></td><td>integer flags to control regex behaviour. reserved for future use</td></tr></tbody></table><h3 id=def-bsubb>def <b>sub</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>sub</span><span class=p>(</span><span class=nx>pattern</span><span class=p>,</span> <span class=nx>repl</span><span class=p>,</span> <span class=nx>text</span><span class=p>,</span> <span class=nx>count</span><span class=p>=</span><span class=mi>0</span><span class=p>,</span> <span class=nx>flags</span><span class=p>=</span><span class=mi>0</span><span class=p>)</span>
</code></pre></div><p>Return the string obtained by replacing the leftmost non-overlapping occurrences of pattern
in string by the replacement repl. If the pattern isn’t found, string is returned unchanged.
repl can be a string or a function; if it is a string, any backslash escapes in it are processed.
That is, \n is converted to a single newline character, \r is converted to a carriage return, and so forth.</p><h6 id=arguments-4>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>pattern</code></td><td><code>string</code></td><td>regular expression pattern string</td></tr><tr><td><code>repl</code></td><td><code>string</code></td><td>string to replace matches with</td></tr><tr><td><code>text</code></td><td><code>string</code></td><td>input string to replace</td></tr><tr><td><code>count</code></td><td><code>int</code></td><td>number of replacements to make, default 0 means replace all matches</td></tr><tr><td><code>flags</code></td><td><code>int</code></td><td>integer flags to control regex behaviour. reserved for future use</td></tr></tbody></table><h2 id=types>Types</h2><h3 id=type-bpatternb>type <b>Pattern</b></h3><h6 id=methods>Methods</h6><h4 id=def-ipatternibmatchb>def <i>Pattern</i>.<b>match</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>Pattern</span><span class=p>.</span><span class=nf>match</span><span class=p>(</span><span class=nx>text</span><span class=p>,</span> <span class=nx>flags</span><span class=p>=</span><span class=mi>0</span><span class=p>)</span>
</code></pre></div><h4 id=def-ipatternibfindallb>def <i>Pattern</i>.<b>findall</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>Pattern</span><span class=p>.</span><span class=nf>findall</span><span class=p>(</span><span class=nx>text</span><span class=p>,</span> <span class=nx>flags</span><span class=p>=</span><span class=mi>0</span><span class=p>)</span>
</code></pre></div><h4 id=def-ipatternibsplitb>def <i>Pattern</i>.<b>split</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>Pattern</span><span class=p>.</span><span class=nf>split</span><span class=p>(</span><span class=nx>text</span><span class=p>,</span> <span class=nx>maxsplit</span><span class=p>=</span><span class=mi>0</span><span class=p>,</span> <span class=nx>flags</span><span class=p>=</span><span class=mi>0</span><span class=p>)</span>
</code></pre></div><h4 id=def-ipatternibsubb>def <i>Pattern</i>.<b>sub</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>Pattern</span><span class=p>.</span><span class=nf>sub</span><span class=p>(</span><span class=nx>repl</span><span class=p>,</span> <span class=nx>text</span><span class=p>,</span> <span class=nx>count</span><span class=p>=</span><span class=mi>0</span><span class=p>,</span> <span class=nx>flags</span><span class=p>=</span><span class=mi>0</span><span class=p>)</span>
</code></pre></div></div></div></div></div></div></div><div class=sub-footer><div class=container><div class=row><div class=col-12><div class=sub-footer-inner><ul><li><a href=https://github.com/mcuadros/ascod>Documentation version v1.3.0</a></li><li>Template by <a href=https://www.zerostatic.io>Robert Austin</a></li></ul></div></div></div></div><script type=text/javascript src=/js/scripts.min.be6fe1294698d6acd837c5182149cd1a24daae9fa1903ce810c264539d254d62.js></script></body></html>
View Git Blame Copy Permalink