core.render.html.env.regex

Module Contents

Functions

regexMatch(render, pattern, string[, flags])

Jinja2 global: Match a string for regular expression pattern.

regexReplace(render, string, pattern, replace)

Jinja2 global: Replace string by regular expression pattern.

regexSearch(render, string, pattern[, flags])

Jinja2 global: Search a string for regular expression pattern.
core.render.html.env.regex.regexMatch(render, pattern, string, flags=0)

Jinja2 global: Match a string for regular expression pattern. This function internally runs re.match().

Parameters:

  • render (core.render.html.default.Render) – The html-renderer instance.

  • pattern (str) – Regular expression pattern to be matched.

  • string (str) – String where to be searched in.

  • flags (int) – Flags to be passed to re.search().

Returns:

A matching object on success, else None.

Return type:

re.Match

core.render.html.env.regex.regexReplace(render, string, pattern, replace)

Jinja2 global: Replace string by regular expression pattern.

Parameters:

  • render (core.render.html.default.Render) – The html-renderer instance.

  • string (str) – String to be replaced.

  • pattern (str) – Regular expression pattern to be matched.

  • replace (str) – Replacement string to be inserted for every matching pattern.

Returns:

The string with the replaced matches.

Return type:

str

core.render.html.env.regex.regexSearch(render, string, pattern, flags=0)

Jinja2 global: Search a string for regular expression pattern. This function internally runs re.search().

Parameters:

  • render (core.render.html.default.Render) – The html-renderer instance.

  • string (str) – String where to be searched in.

  • pattern (str) – Regular expression pattern to be matched.

  • flags – Flags to be passed to re.search().

Returns:

A matching object on success, else None.

Return type:

Optional[re.Match]