Function check

tools/api_surface/check_api_surface.py:169–250

Run the API surface check. Returns exit code.

(open_source_root: Path, strict: bool = False)

def check(open_source_root: Path, strict: bool = False) -> int:
    """Run the API surface check. Returns exit code."""
    if not BASELINE_PATH.exists():
        print(f"{RED}No baseline found at {BASELINE_PATH}{RESET}")
        print("Run with --update to generate one.")
        return 1

    baseline = json.loads(BASELINE_PATH.read_text())
    current = extract_api(open_source_root)

    all_warnings = []
    all_errors = []

    # Interfaces
    print(f"\n{BOLD}Checking interfaces...{RESET}")
    w, e = _diff_interfaces(
        baseline.get("interfaces", {}), current.get("interfaces", {})
    )
    all_warnings.extend(w)
    all_errors.extend(e)

    # Type aliases
    print(f"{BOLD}Checking type aliases...{RESET}")
    w, e = _diff_dict(baseline.get("types", {}), current.get("types", {}), "type")
    all_warnings.extend(w)
    all_errors.extend(e)

    # Enums
    print(f"{BOLD}Checking enums...{RESET}")
    b_enums_flat = {}
    c_enums_flat = {}
    for ename, members in baseline.get("enums", {}).items():
        for mname, mval in members.items():
            b_enums_flat[f"{ename}.{mname}"] = mval
    for ename, members in current.get("enums", {}).items():
        for mname, mval in members.items():
            c_enums_flat[f"{ename}.{mname}"] = mval
    w, e = _diff_dict(b_enums_flat, c_enums_flat, "enum member")
    all_warnings.extend(w)
    all_errors.extend(e)

    # Classes
    print(f"{BOLD}Checking classes...{RESET}")
    w, e = _diff_classes(baseline.get("classes", {}), current.get("classes", {}))
    all_warnings.extend(w)
    all_errors.extend(e)

    # Report
    print()
    if all_errors:
        print(f"{RED}{BOLD}Breaking changes detected (removals):{RESET}")
        for msg in all_errors:
            error(msg)
        print()

    if all_warnings:
        print(f"{YELLOW}{BOLD}API additions/modifications detected:{RESET}")
        for msg in all_warnings: