linkahead.utils.escape module

linkahead.utils.escape.escape_dquoted_text(text: str) → str

Return an escaped version of the argument.

The characters \, * and " need to be escaped if used in double quoted expressions in the query language.

This function returns the given string where the characters \, " and * are escaped by a \ (backslash character).

Parameters:

text (str) – The text to be escaped.

Returns:

out – The escaped text.

Return type:

str

linkahead.utils.escape.escape_quoted_text(text: str) → str

Please use escape_squoted_text or escape_dquoted_text instead of this function.

linkahead.utils.escape.escape_squoted_text(text: str) → str

Return an escaped version of the argument.

The characters \, * and ' need to be escaped if used in single quoted expressions in the query language.

This function returns the given string where the characters \, ' and * are escaped by a \ (backslash character).

Parameters:

text (str) – The text to be escaped.

Returns:

out – The escaped text.

Return type:

str