Skip to content

Formatting

ballsdex.core.utils.formatting

escape 

escape(text: str, *, mass_mentions: bool = False, formatting: bool = False) -> str

Get text with all mass mentions or markdown escaped.

Parameters:

  • text (str) –

    The text to be escaped.

  • mass_mentions (bool, default: False ) –

    Set to True to escape mass mentions in the text.

  • formatting (bool, default: False ) –

    Set to True to escape any markdown formatting in the text.

Returns:

  • str –

    The escaped text.

Source code in ballsdex/core/utils/formatting.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def escape(text: str, *, mass_mentions: bool = False, formatting: bool = False) -> str:
    """
    Get text with all mass mentions or markdown escaped.

    Parameters
    ----------
    text: str
        The text to be escaped.
    mass_mentions: bool
        Set to `True` to escape mass mentions in the text.
    formatting: bool
        Set to `True` to escape any markdown formatting in the text.

    Returns
    -------
    str
        The escaped text.
    """
    if mass_mentions:
        text = text.replace("@everyone", "@\u200beveryone")
        text = text.replace("@here", "@\u200bhere")
    if formatting:
        text = discord.utils.escape_markdown(text)
    return text

format_command_mentions 

format_command_mentions(text: str, bot: BallsDexBot) -> str

Replace every </command name> reference in a text by a clickable slash command mention.

This allows admin-configured messages to link to slash commands without knowing their IDs. Unknown commands, or commands that were never synced, fall back to `/command name`.

Parameters:

  • text (str) –

    The text to scan for command references.

  • bot (BallsDexBot) –

    The bot, used to resolve command IDs assigned on sync.

Returns:

  • str –

    The text with its command references resolved.

Source code in ballsdex/core/utils/formatting.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
def format_command_mentions(text: str, bot: "BallsDexBot") -> str:
    """
    Replace every `</command name>` reference in a text by a clickable slash command mention.

    This allows admin-configured messages to link to slash commands without knowing their IDs.
    Unknown commands, or commands that were never synced, fall back to `` `/command name` ``.

    Parameters
    ----------
    text: str
        The text to scan for command references.
    bot: BallsDexBot
        The bot, used to resolve command IDs assigned on sync.

    Returns
    -------
    str
        The text with its command references resolved.
    """

    def replace(match: re.Match[str]) -> str:
        parts = match.group(1).split()
        command = bot.tree.get_command(parts[0])
        for part in parts[1:]:
            if not isinstance(command, app_commands.Group):
                command = None
                break
            command = command.get_command(part)
        name = " ".join(parts)
        if command is None:
            return f"`/{name}`"
        return command.extras.get("mention", f"`/{name}`")

    return COMMAND_MENTION_RE.sub(replace, text)

pagify 

pagify(text: str, delims: Sequence[str] = ['\n'], *, priority: bool = False, escape_mass_mentions: bool = True, shorten_by: int = 8, page_length: int = 2000, prefix: str = '', suffix: str = '') -> Iterator[str]

Generate multiple pages from the given text.

Parameters:

  • text (str) –

    The content to pagify and send.

  • delims (Sequence[str], default: ['\n'] ) –

    Characters where page breaks will occur. If no delimiters are found in a page, the page will break after page_length characters. By default this only contains the newline.

Other Parameters:

  • priority (bool) –

    Set to True to choose the page break delimiter based on the order of delims. Otherwise, the page will always break at the last possible delimiter.

  • escape_mass_mentions (bool) –

    If True, any mass mentions (here or everyone) will be silenced.

  • shorten_by (int) –

    How much to shorten each page by. Defaults to 8.

  • page_length (int) –

    The maximum length of each page. Defaults to 2000.

Yields:

  • str –

    Pages of the given text.

Source code in ballsdex/core/utils/formatting.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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
def pagify(
    text: str,
    delims: Sequence[str] = ["\n"],
    *,
    priority: bool = False,
    escape_mass_mentions: bool = True,
    shorten_by: int = 8,
    page_length: int = 2000,
    prefix: str = "",
    suffix: str = "",
) -> Iterator[str]:
    """
    Generate multiple pages from the given text.

    Parameters
    ----------
    text: str
        The content to pagify and send.
    delims: Sequence[str]
        Characters where page breaks will occur. If no delimiters are found
        in a page, the page will break after `page_length` characters.
        By default this only contains the newline.

    Other Parameters
    ----------------
    priority: bool
        Set to `True` to choose the page break delimiter based on the
        order of `delims`. Otherwise, the page will always break at the
        last possible delimiter.
    escape_mass_mentions: bool
        If `True`, any mass mentions (here or everyone) will be
        silenced.
    shorten_by: int
        How much to shorten each page by. Defaults to 8.
    page_length: int
        The maximum length of each page. Defaults to 2000.

    Yields
    ------
    str
        Pages of the given text.
    """
    in_text = text
    page_length -= shorten_by + len(prefix) + len(suffix)
    while len(in_text) > page_length:
        this_page_len = page_length
        if escape_mass_mentions:
            this_page_len -= in_text.count("@here", 0, page_length) + in_text.count("@everyone", 0, page_length)
        closest_delim = (in_text.rfind(d, 1, this_page_len) for d in delims)
        if priority:
            closest_delim = next((x for x in closest_delim if x > 0), -1)
        else:
            closest_delim = max(closest_delim)
        closest_delim = closest_delim if closest_delim != -1 else this_page_len
        if escape_mass_mentions:
            to_send = escape(in_text[:closest_delim], mass_mentions=True)
        else:
            to_send = in_text[:closest_delim]
        if len(to_send.strip()) > 0:
            yield f"{prefix}{to_send}{suffix}"
        in_text = in_text[closest_delim:]

    if len(in_text.strip()) > 0:
        in_text = f"{prefix}{in_text}{suffix}"
        if escape_mass_mentions:
            yield escape(in_text, mass_mentions=True)
        else:
            yield in_text