core.render.html.env.regex

Module Contents

Functions

regexMatch(→ re.Match)

Jinja2 global: Match a string for regular expression pattern.

regexReplace(→ str)

Jinja2 global: Replace string by regular expression pattern.

regexSearch(→ Optional[re.Match])

Jinja2 global: Search a string for regular expression pattern.
core.render.html.env.regex.regexMatch(render: core.render.html.default.Render, pattern: str, string: str, flags: int = 0) → re.Match

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

Parameters:

  • render – The html-renderer instance.

  • pattern – Regular expression pattern to be matched.

  • string – String where to be searched in.

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

Returns:

A matching object on success, else None.

core.render.html.env.regex.regexReplace(render: core.render.html.default.Render, string: str, pattern: str, replace: str) → str

Jinja2 global: Replace string by regular expression pattern.

Parameters:

  • render – The html-renderer instance.

  • string – String to be replaced.

  • pattern – Regular expression pattern to be matched.

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

Returns:

The string with the replaced matches.

core.render.html.env.regex.regexSearch(render: core.render.html.default.Render, string: str, pattern: str, flags=0) → re.Match | None

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

Parameters:

  • render – The html-renderer instance.

  • string – String where to be searched in.

  • pattern – Regular expression pattern to be matched.

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

Returns:

A matching object on success, else None.