fediverse_pasture_inputs.utils

fediverse_pasture_inputs.utils

app_to_profile_map module-attribute

app_to_profile_map = {'misskey': 'firefish'}

Maps app to profile used to generate details and support tables

escape_markdown

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

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

format_as_json(data: dict | None, small=False) -> List[str]

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

def format_as_json(data: dict | None, 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

is_supported(item) -> str

Returns ✅ is item exists

>>> is_supported(None)
'❌'

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

Source code in fediverse_pasture_inputs/utils.py

def is_supported(item) -> str:
    """
    Returns ✅ is item exists

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

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

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

pre_format

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

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

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

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

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

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]

value_from_dict_for_app

value_from_dict_for_app(
    dictionary: dict,
    app: str,
    default: str | list[str] = "❌",
)

Returns the value corresponding to app from dictionary by performing a lookup in app_to_profile_map and assuming mastodon is the default value.

>>> dictionary = {"known": "known",
...     "mastodon": "mastodon",
...     "firefish": "firefish"}
>>> value_from_dict_for_app(dictionary, "unknown")
'mastodon'

>>> value_from_dict_for_app(dictionary, "known")
'known'

>>> value_from_dict_for_app(dictionary, "misskey")
'firefish'

Source code in fediverse_pasture_inputs/utils.py

def value_from_dict_for_app(
    dictionary: dict, app: str, default: str | list[str] = "❌"
):
    """Returns the value corresponding to app from dictionary
    by performing a lookup in [app_to_profile_map][fediverse_pasture_inputs.utils.app_to_profile_map] and assuming `mastodon` is the default
    value.

    ```pycon
    >>> dictionary = {"known": "known",
    ...     "mastodon": "mastodon",
    ...     "firefish": "firefish"}
    >>> value_from_dict_for_app(dictionary, "unknown")
    'mastodon'

    >>> value_from_dict_for_app(dictionary, "known")
    'known'

    >>> value_from_dict_for_app(dictionary, "misskey")
    'firefish'

    ```
    """
    if app in dictionary:
        # FIXME Not sure if this is what I want ...
        func = dictionary.get(app)

        if isinstance(func, str):
            return func

        if func is None:
            raise ValueError(f"unknown function for app {app}")

        if func.__code__.co_argcount > 1:
            return func

        return lambda x: func(x) if x else default

    else:
        profile = app_to_profile_map.get(app, "mastodon")
        return value_from_dict_for_app(dictionary, profile, default=default)

with_tooltip

with_tooltip(content: str, tooltip: str) -> str

>>> with_tooltip("content", "tooltip")
"<span data-tooltip='tooltip' display='inline'>content</span>"

Source code in fediverse_pasture_inputs/utils.py

def with_tooltip(content: str, tooltip: str) -> str:
    """
    ```pycon
    >>> with_tooltip("content", "tooltip")
    "<span data-tooltip='tooltip' display='inline'>content</span>"

    ```
    """
    escaped_tooltip = html.escape(tooltip).replace("\n", "\\n")
    return f"<span data-tooltip='{escaped_tooltip}' display='inline'>{content}</span>"