Function _format_source_snippet

python/tvm/script/parser/core/diagnostics.py:188–258

Format a source code snippet with a column/span marker. Renders every source line spanned by the diagnostic (``lineno`` through ``end_lineno``, inclusive) with a per-line gutter, followed by a caret underline covering the offending span. For a single-line span (``end_lineno == linen

(
    source_lines: list,
    lineno: int,
    col_offset: int,
    end_lineno: int,
    end_col_offset: int,
)

def _format_source_snippet(
    source_lines: list,
    lineno: int,
    col_offset: int,
    end_lineno: int,
    end_col_offset: int,
) -> str:
    """Format a source code snippet with a column/span marker.

    Renders every source line spanned by the diagnostic (``lineno`` through
    ``end_lineno``, inclusive) with a per-line gutter, followed by a caret
    underline covering the offending span. For a single-line span
    (``end_lineno == lineno``) only the columns ``col_offset`` (inclusive)
    through ``end_col_offset`` (exclusive) are underlined; for a multi-line
    span the underline covers the start column to end-of-line on the first
    line, the full text of interior lines, and the start of the final line up
    to ``end_col_offset``.

    Parameters
    ----------
    source_lines : list of str
        Lines of the source code.

    lineno : int
        1-based starting line number in the source.

    col_offset : int
        1-based starting column (inclusive) on ``lineno``.

    end_lineno : int
        1-based ending line number in the source (>= ``lineno``).

    end_col_offset : int
        1-based ending column (exclusive) on ``end_lineno``.

    Returns
    -------
    snippet : str
        Formatted source snippet with caret-marker line(s).
    """
    if end_lineno < lineno:
        end_lineno = lineno

    # Determine the gutter width so that all line numbers line up.
    header_width = len(f" {end_lineno} ")
    no_line_header = " " * header_width

    parts = [f"{no_line_header}|  "]
    for cur_lineno in range(lineno, end_lineno + 1):
        idx = cur_lineno - 1
        if not 0 <= idx < len(source_lines):
            continue
        line_text = source_lines[idx].rstrip("\n")
        line_header = f" {cur_lineno} ".rjust(header_width)

        # Compute the underline span [start_col, stop_col) for this line.
        start_col = col_offset if cur_lineno == lineno else 1
        stop_col = end_col_offset if cur_lineno == end_lineno else len(line_text) + 1