Skip to content

symfonic.diagnostics.inspection.report

report

Render an inspection as a Markdown migration report.

The report is the deliverable an adopter keeps; the CLI lines are what they read once. So it states its own inputs at the top -- which project, how many configuration keys, which optional roots were found -- because a finding list with no provenance is unreviewable six weeks later, and a reader must be able to tell "clean" from "not inspected" without running anything.

render_migration_report 

render_migration_report(inspection: MigrationInspection, context: InspectionContext) -> str

Return the Markdown migration inspection report for inspection.

Source code in src/symfonic/diagnostics/inspection/report.py 
114
115
116
117
118
119
120
121
122
def render_migration_report(
    inspection: MigrationInspection, context: InspectionContext
) -> str:
    """Return the Markdown migration inspection report for *inspection*."""
    lines = _preamble(inspection, context)
    lines += _summary(inspection)
    lines += _sections(inspection)
    lines += _closing(inspection)
    return "\n".join(lines).rstrip() + "\n"