Skip to content

visualdynamics.report.markdown

markdown

The markdown subset a report's text blocks speak.

Hand-rolled for the same reason the viewers are: nothing third-party rides inside a deliverable. The subset is what a test report actually uses — headings with #, bold, italic, code, bullet and numbered lists, paragraphs on blank lines. Everything is HTML-escaped first, so a report cannot smuggle markup; what you type is what renders.

Functions:

Name Description
to_html

The markdown subset as HTML, one string in, one string out.

Functions:

to_html 

to_html(text: str) -> str

The markdown subset as HTML, one string in, one string out.

Source code in src/visualdynamics/report/markdown.py 
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
def to_html(text: str) -> str:
    """The markdown subset as HTML, one string in, one string out."""
    out, paragraph, listing = [], [], None

    def flush_paragraph() -> None:
        if paragraph:
            out.append('<p>' + '<br>'.join(paragraph) + '</p>')
            paragraph.clear()

    def flush_list() -> None:
        nonlocal listing
        if listing:
            out.append(f'</{listing}>')
            listing = None

    for line in (text or '').splitlines():
        stripped = line.strip()
        heading = _HEADING.match(stripped)
        bullet = _BULLET.match(stripped)
        numbered = _NUMBERED.match(stripped)
        if not stripped:
            flush_paragraph()
            flush_list()
        elif heading:
            flush_paragraph()
            flush_list()
            level = len(heading.group(1)) + 1   # h1 is the report title
            out.append(f'<h{level}>{_inline(heading.group(2))}</h{level}>')
        elif bullet or numbered:
            flush_paragraph()
            wanted = 'ul' if bullet else 'ol'
            if listing != wanted:
                flush_list()
                out.append(f'<{wanted}>')
                listing = wanted
            out.append(f'<li>{_inline((bullet or numbered).group(1))}</li>')
        else:
            flush_list()
            paragraph.append(_inline(stripped))
    flush_paragraph()
    flush_list()
    return '\n'.join(out)