Skip to content
bearing-researchPublic

Repository files navigation

diffcone

CI Docs PyPI Python License Ruff uv dependencies: none

Run the tests your change can affect, and know why each one was picked.

diffcone compares two versions of a Python repository, finds the functions, methods and classes that changed, and follows the code's dependencies back to the tests and benchmarks that can observe them. Each selected test comes with the reason it was selected.

$ diffcone plan --base main --head WORKTREE --discover pytest \
    --source-root src --source-root . --format text
...
changed symbols (1):
  calc.ops.mul [function] body_changed

selected targets (2):
  pytest: tests/test_calc.py::test_mul
    - dependency: calc.ops.mul body_changed
      target:pytest:tests/test_calc.py::test_mul -[entry]-> tests.test_calc.test_mul -[references]-> calc.ops.mul
  pytest: tests/test_calc.py::test_square
    - dependency: calc.ops.mul body_changed
      target:pytest:tests/test_calc.py::test_square -[entry]-> tests.test_calc.test_square -[references]-> calc.ops.square -[references]-> calc.ops.mul

unselected targets (1):
  pytest: tests/test_calc.py::test_add
...
  • Every selection is explained: the report shows the chain of calls and references from each test to the change.
  • It errs on the side of running more: when diffcone can't tell what a change reaches, it selects more tests and says why.
  • pytest and ASV: tests and benchmarks are found from your configuration and source, the way each runner collects them.
  • Two ways to plan:
    • From the code (the default). diffcone reads your source and git history. It never imports your code or runs your tests.
    • From execution evidence (opt-in, Python 3.12+). For large codebases where nearly everything imports everything. You run your test suite once under diffcone's recorder, which notes what each test ran; plans then select from that recording. Recording runs your tests; planning from a recording only reads it.

Install

Python 3.11 or later and git; no other dependencies.

uv tool install diffcone    # or: pipx install diffcone, pip install diffcone

Use

# Which tests can my uncommitted changes affect?
diffcone plan --base main --head WORKTREE --discover pytest --format text

# Run only those tests (arguments after -- go to pytest)
diffcone run --base main --head WORKTREE --discover pytest --command "uv run pytest" -- -x

# Run the suite once under the recorder, then plan from the recording (Python 3.12+)
diffcone collect --command "uv run pytest" -- -n 8
diffcone plan --base main --head HEAD --discover pytest --evidence auto -o plan.json

# Did the plan select every test that failed in a full run?
diffcone check --plan plan.json --full full.xml

For a src layout, add --source-root src --source-root . so modules get their import names.

Documentation

Read the documentation at bearing-research.github.io/diffcone:

Status

diffcone is alpha software. Its selections have been checked against the full test suites of more than 40 open-source projects. See the changelog for what each release contains.

Contributing

uv sync
uv run pytest
uv run ruff check src tests scripts && uv run ruff format --check src tests scripts
uv run ty check

See the development guide and AGENTS.md.

License

MIT; see LICENSE.

Releases

Packages

Contributors

Languages