vulturecov 0.1.0

Vulture and Coverage.py combined: Find dead code in your Python project.

vulturecov

vulturecov is a tool to filter the dead code false positives found by Vulture using Coverage.py.

The rationale is that if a line of code is covered by a test, then it is unlikely to be dead code.

Installation

pip install vulturecov

Usage

First, generate the Vulture report:

vulture src/my_package > vulture_report.txt
vulture src/my_package whitelist.py > vulture_report.txt  # with a whitelist

Then, generate the Coverage report using pytest for example:

pytest --cov=src/my_package --cov-report=json:coverage.json

Once you have the two reports, you can use vulturecov to filter the Vulture report:

Show the dead code (lines of code that are found by Vulture and not covered by tests):

vulturecov vulture_report.txt coverage.json  # print the result to stdout
vulturecov vulture_report.txt coverage.json --output vulturecov_report.txt  # write the result to a file

Only show the false positives (lines of code that are covered by tests):

vulturecov vulture_report.txt coverage.json --false-positives  # print the result to stdout
vulturecov vulture_report.txt coverage.json --false-positives --output vulture_fp.txt  # write the result to a file

To add the false positives in your Vulture whitelist:

vulturecov vulture_report.txt coverage.json --false-positives >> whitelist.py