Skip to content

topmark.presentation.text.probe

topmark / presentation / text / probe

TEXT presentation for the topmark probe command.

This module renders resolution probe diagnostics for console-oriented TEXT output. Unlike check/strip pipeline renderers, probe output is explanatory rather than actionable: it reports resolution status, selected file type and processor, scored candidates, and match signals.

render_probe_output_text

render_probe_output_text(report)

Render human-facing TEXT output for the probe command.

Parameters:

Name Type Description Default
report ProbeCommandHumanReport

Prepared human report for the probe command.

required

Returns:

Type Description
str

Rendered TEXT output for the prepared probe report.

Source code in src/topmark/presentation/text/probe.py
def render_probe_output_text(
    report: ProbeCommandHumanReport,
) -> str:
    """Render human-facing TEXT output for the probe command.

    Args:
        report: Prepared human report for the probe command.

    Returns:
        Rendered TEXT output for the prepared probe report.
    """
    parts: list[str] = []

    # TEXT banner is shown at -v and above.
    if report.verbosity_level > 0:
        parts.append(
            _render_probe_banner_text(
                n_files=report.file_list_total,
                styled=report.styled,
            )
        )
        parts.append("")

    # Probe-specific per-file resolution diagnostics.
    parts.append(
        _render_probe_results_text(
            view_results=report.view_results,
            verbosity_level=report.verbosity_level,
            styled=report.styled,
        )
    )

    return "\n".join(parts)