Skip to content

fediverse_pasture_inputs.utils

fediverse_pasture_inputs.utils

escape_markdown(text)

Escapes markdown characters, necessary to display markdown (as done for firefish)

>>> escape_markdown("*bold*")
'\\*bold\\*'
Source code in fediverse_pasture_inputs/utils.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def escape_markdown(text):
    """Escapes markdown characters, necessary to display markdown (as done for firefish)

    ```pycon
    >>> escape_markdown("*bold*")
    '\\\\*bold\\\\*'

    ```
    """

    if text is None:
        return "-"

    text = text.replace("`", "\\`")
    text = text.replace("*", "\\*")
    text = text.replace("_", "\\_")
    text = text.replace("[", "\\[")
    text = text.replace("]", "\\]")
    return text

format_as_json(data, small=False)

Displays a dictionary as pretty printed json.

>>> format_as_json({"x": 1})
['<pre
    style="line-height:1;">{</pre><pre
    style="line-height:1;">  "x": 1</pre><pre
    style="line-height:1;">}</pre>']

Parameters:

Name Type Description Default
small

If true sets font-size to 75%.

 False
Source code in fediverse_pasture_inputs/utils.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
def format_as_json(data: dict, small=False) -> List[str]:
    """Displays a dictionary as pretty printed json.

    ```pycon
    >>> format_as_json({"x": 1})
    ['<pre
        style="line-height:1;">{</pre><pre
        style="line-height:1;">  "x": 1</pre><pre
        style="line-height:1;">}</pre>']


    ```
    :param small: If true sets font-size to 75%."""
    style = "line-height:1;"
    if small:
        style += "font-size:75%;"

    return [
        "".join(
            f"""<pre style="{style}">{sanitize_backslash(x)}</pre>"""
            for x in json.dumps(data, indent=2).split("\n")
        )
    ]

is_supported(item)

Returns ✅ is item exists

>>> is_supported(None)
''

>>> is_supported({"type": "Note"})
'✅'
Source code in fediverse_pasture_inputs/utils.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def is_supported(item):
    """
    Returns ✅ is item exists

    ```pycon
    >>> is_supported(None)
    ''

    >>> is_supported({"type": "Note"})
    '✅'

    ```
    """
    return "✅" if item else ""

pre_format(text, pre_wrap=False)

Escapes html text to pre formatted markdown

>>> pre_format(True)
['true']

>>> pre_format('<b>bold</b>\n<i>italic</i>')
['<pre>&lt;b&gt;bold&lt;/b&gt;</pre><pre>&lt;i&gt;italic&lt;/i&gt;</pre>']
Source code in fediverse_pasture_inputs/utils.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def pre_format(text, pre_wrap=False):
    """Escapes html text to pre formatted markdown

    ```pycon
    >>> pre_format(True)
    ['true']

    >>> pre_format('<b>bold</b>\\n<i>italic</i>')
    ['<pre>&lt;b&gt;bold&lt;/b&gt;</pre><pre>&lt;i&gt;italic&lt;/i&gt;</pre>']

    ```
    """
    if text is None:
        return [""]
    if isinstance(text, bool):
        return ["true" if text else "false"]
    if isinstance(text, list):
        return sum((pre_format(x, pre_wrap=pre_wrap) for x in text), [])

    return ["".join(pre_wrapped(x, pre_wrap=pre_wrap) for x in text.split("\n"))]

pre_wrapped(x, pre_wrap) 

>>> pre_wrapped("test", False)
'<pre>test</pre>'

>>> pre_wrapped("test", True)
'<pre style="white-space: pre-wrap;">test</pre>'
Source code in fediverse_pasture_inputs/utils.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def pre_wrapped(x, pre_wrap):
    """

    ```pycon
    >>> pre_wrapped("test", False)
    '<pre>test</pre>'

    >>> pre_wrapped("test", True)
    '<pre style="white-space: pre-wrap;">test</pre>'

    ```
    """
    style = ' style="white-space: pre-wrap;"' if pre_wrap else ""

    return f"<pre{style}>{html.escape(x)}</pre>"

safe_first_element(item)

Returns the first element of a list, otherwise None

>>> safe_first_element([])

>>> safe_first_element(None)

>>> safe_first_element(["a", "b"])
'a'
Source code in fediverse_pasture_inputs/utils.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def safe_first_element(item):
    """Returns the first element of a list, otherwise None

    ```pycon
    >>> safe_first_element([])

    >>> safe_first_element(None)

    >>> safe_first_element(["a", "b"])
    'a'

    ```
    """
    if not item or not isinstance(item, list) or len(item) == 0:
        return None
    return item[0]