format_data.py

#

Roughly a UI component for data

from typing import List

from pydoc_fork.custom_types import TypeLike
from pydoc_fork.formatter_html import markup
from pydoc_fork.utils import getdoc

#

Produce html documentation for a data descriptor.

def docdata(
    the_object: TypeLike,
    name: str = "",  # Null safety
) -> str:

#

    results: List[str] = []
    push = results.append

    if name:
        push(f"<dl><dt><strong>{name}</strong></dt>\n")
    doc = markup(getdoc(the_object))
    if doc:
        push(f"<dd><tt>{doc}</tt></dd>\n")
    push("</dl>\n")

    return "".join(results)