Skip to content

Sanitizer Utilities

escape_html(val)

Escape HTML characters.

Parameters:

Name Type Description Default
val (str, required)

String to escape.

 required

Returns:

Name Type Description
str str

Escaped string.
Source code in src/potato_util/sanitizer.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
@validate_call
def escape_html(val: str) -> str:
    """Escape HTML characters.

    Args:
        val (str, required): String to escape.

    Returns:
        str: Escaped string.
    """

    val = val.strip()
    _escaped = html.escape(val)
    return _escaped

escape_url(val)

Escape URL characters.

Parameters:

Name Type Description Default
val (AnyHttpUrl, required)

String to escape.

 required

Returns:

Name Type Description
str str

Escaped string.
Source code in src/potato_util/sanitizer.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
@validate_call
def escape_url(val: AnyHttpUrl | str) -> str:
    """Escape URL characters.

    Args:
        val (AnyHttpUrl, required): String to escape.

    Returns:
        str: Escaped string.
    """

    if isinstance(val, str):
        val = AnyHttpUrl(val)

    _escaped = quote(str(val))
    return _escaped

sanitize_special_chars(val, mode='LOW')

Sanitize special characters. Available modes: - "BASE" or "HTML": Basic HTML special characters. - "LOW": Low-risk special characters. - "MEDIUM": Medium-risk special characters. - "HIGH", "SCRIPT", or "SQL": High-risk special characters. - "STRICT": Strict mode, removes most special characters.

Parameters:

Name Type Description Default
val (str, required)

String to sanitize.

 required
mode str

Sanitization mode. Defaults to "LOW".

 'LOW'

Raises:

Type Description
ValueError

If mode argument value is invalid.

Returns:

Name Type Description
str str

Sanitized string.
Source code in src/potato_util/sanitizer.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
@validate_call
def sanitize_special_chars(val: str, mode: str = "LOW") -> str:
    """Sanitize special characters.
    Available modes:
        - "BASE" or "HTML": Basic HTML special characters.
        - "LOW": Low-risk special characters.
        - "MEDIUM": Medium-risk special characters.
        - "HIGH", "SCRIPT", or "SQL": High-risk special characters.
        - "STRICT": Strict mode, removes most special characters.

    Args:
        val  (str, required): String to sanitize.
        mode (str, optional): Sanitization mode. Defaults to "LOW".

    Raises:
        ValueError: If `mode` argument value is invalid.

    Returns:
        str: Sanitized string.
    """

    _pattern = r""
    mode = mode.upper().strip()
    if (mode == "BASE") or (mode == "HTML"):
        _pattern = SPECIAL_CHARS_BASE_REGEX
    elif mode == "LOW":
        _pattern = SPECIAL_CHARS_LOW_REGEX
    elif mode == "MEDIUM":
        _pattern = SPECIAL_CHARS_MEDIUM_REGEX
    elif (mode == "HIGH") or (mode == "SCRIPT") or (mode == "SQL"):
        _pattern = SPECIAL_CHARS_HIGH_REGEX
    elif mode == "STRICT":
        _pattern = SPECIAL_CHARS_STRICT_REGEX
    else:
        raise ValueError(f"`mode` argument value '{mode}' is invalid!")

    _sanitized = re.sub(pattern=_pattern, repl="", string=val)
    return _sanitized