diff_cover_cli_quickstart_git_branch_coverage_report.py

1import subprocess
2
3# Diff-cover is primarily designed as a command-line tool.
4# The official "quickstart" involves running it via the shell 
5# to compare coverage reports against a git diff.
6
7def run_diff_cover():
8    # 1. Generate a coverage XML report (e.g., using pytest-cov)
9    subprocess.run(["pytest", "--cov=.", "--cov-report=xml"])
10
11    # 2. Run diff-cover to compare the coverage against the main branch
12    # This will output a report showing coverage for only the changed lines.
13    subprocess.run(["diff-cover", "coverage.xml", "--compare-branch=origin/main"])
14
15if __name__ == "__main__":
16    run_diff_cover()