Function print_validate_all_results

scripts/validate_docstrings.py:357–396

(
    output_format: str,
    prefix: str | None,
    ignore_deprecated: bool,
    ignore_errors: dict[str, set[str]],
)

def print_validate_all_results(
    output_format: str,
    prefix: str | None,
    ignore_deprecated: bool,
    ignore_errors: dict[str, set[str]],
):
    if output_format not in ("default", "json", "actions"):
        raise ValueError(f'Unknown output_format "{output_format}"')
    if ignore_errors is None:
        ignore_errors = {}

    result = validate_all(prefix, ignore_deprecated)

    if output_format == "json":
        sys.stdout.write(json.dumps(result))
        return 0

    prefix = "##[error]" if output_format == "actions" else ""
    exit_status = 0
    for func_name, res in result.items():
        error_messages = dict(res["errors"])
        actual_failures = set(error_messages)
        expected_failures = ignore_errors.get(func_name, set()) | ignore_errors.get(
            None, set()
        )
        for err_code in actual_failures - expected_failures:
            sys.stdout.write(
                f"{prefix}{res['file']}:{res['file_line']}:"
                f"{err_code}:{func_name}:{error_messages[err_code]}\n"
            )
            exit_status += 1
        for err_code in ignore_errors.get(func_name, set()) - actual_failures:
            sys.stdout.write(
                f"{prefix}{res['file']}:{res['file_line']}:"
                f"{err_code}:{func_name}:"
                "EXPECTED TO FAIL, BUT NOT FAILING\n"
            )
            exit_status += 1

    return exit_status


def print_validate_one_results(