Skip to content

topmark.presentation.text.version

topmark / presentation / text / version

TEXT (ANSI-styled) renderers for the topmark version command.

These helpers only render the content, they do not write to the console.

Notes

Machine-readable formats (JSON/NDJSON) are handled via the version machine serializers and the generic CLI machine emitter.

render_version_text 

render_version_text(report)

Render topmark version output in the TEXT (ANSI-styled) format.

Parameters:

Name Type Description Default
report VersionHumanReport

The human version information report.

 required

Returns:

Type Description
str

A text document as a single string.
Source code in src/topmark/presentation/text/version.py 
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
def render_version_text(report: VersionHumanReport) -> str:
    """Render `topmark version` output in the TEXT (ANSI-styled) format.

    Args:
        report: The human version information report.

    Returns:
        A text document as a single string.
    """
    # Note: the stylers already check `report.styled` so we don't need `maybe_style()`
    heading_styler: TextStyler = style_for_role(StyleRole.HEADING_TITLE, styled=report.styled)
    emphasis_styler: TextStyler = style_for_role(StyleRole.EMPHASIS, styled=report.styled)
    warning_styler: TextStyler = style_for_role(StyleRole.WARNING, styled=report.styled)

    parts: list[str] = []

    version_text: str = emphasis_styler(
        report.version_text,
    )

    if report.verbosity_level > 0:
        parts.append(
            heading_styler(
                f"TopMark version ({report.version_format}):",
            )
        )
        parts.append(f"    {version_text}")
    else:
        parts.append(version_text)

    if report.error is not None:
        parts.append(
            warning_styler(
                f"Warning: {report.error}",
            )
        )

    return "\n".join(parts)