Function postprocess

explainshell/extraction/postprocess.py:243–285

Run selected post-processing steps. steps=None means all. Otherwise a subset like ["sanitize", "dedup", "strip_blanks", "drop_empty", "sanity_check_spans"].

(
    options: list[Option],
    steps: list[str] | None = None,
)

def postprocess(
    options: list[Option],
    steps: list[str] | None = None,
) -> tuple[list[Option], PostProcessStats]:
    """Run selected post-processing steps.

    steps=None means all. Otherwise a subset like
    ["sanitize", "dedup", "strip_blanks", "drop_empty", "sanity_check_spans"].
    """
    all_steps = {
        "sanitize",
        "dedup",
        "strip_blanks",
        "drop_empty",
        "sanity_check_spans",
    }
    active = set(steps) if steps is not None else all_steps
    stats = PostProcessStats()

    if "sanitize" in active:
        options = [sanitize_option(opt) for opt in options]

    if "strip_blanks" in active:
        new_opts = []
        for opt in options:
            stripped = strip_trailing_blanks(opt)
            if stripped is not opt:
                stats.blank_description_stripped += 1
            new_opts.append(stripped)
        options = new_opts

    if "dedup" in active:
        options, removed = dedup_options(options)
        stats.deduped_options = removed

    if "drop_empty" in active:
        options, removed = drop_empty(options)
        stats.dropped_empty = removed

    if "sanity_check_spans" in active:
        sanity_check_line_spans(options)

    return options, stats