My SUT looks like:
foo.py
bar.py
tests/__init__.py [empty]
tests/foo_tests.py
tests/bar_tests.py
tests/integration/__init__.py [empty]
tests/integration/foo_test
I have a lot of top-level Python files/packages and find it annoying to list them all manually using --cover-package, so I made two aliases for myself. Alias nosetests_cover
will run coverage with all your top-level Python files/packages listed in --cover-package. Alias nosetests_cover_sort
will do the same and additionally sort your results by coverage percentage.
nosetests_cover_cmd="nosetests --with-coverage --cover-erase --cover-inclusive --cover-package=\$( ls | sed -r 's/[.]py$//' | fgrep -v '.' | paste -s -d ',' )"
alias nosetests_cover=$nosetests_cover_cmd
alias nosetests_cover_sort="$nosetests_cover_cmd 2>&1 | fgrep '%' | sort -nr -k 4"
Notes:
-nr
with -n
in the sort command.Details:
I don't claim that these are the most efficient commands to achieve the results I want. They're just the commands I happened to come up with. =P
The main thing to explain would be the argument to --cover-package. It builds the comma-separated list of top-level Python file/package names (with ".py" stripped from file names) as follows:
\$
-- Escapes the $
character in a double-quoted string.$( )
-- Inserts the result of the command contained within.ls
-- Lists all names in current directory (must be top-level Python directory).| sed -r 's/[.]py$//'
-- In the list, replaces "foo_bar.py" with "foo_bar".| fgrep -v '.'
-- In the list, removes all names without a dot (e.g. removes foo_bar.pyc and notes.txt).| paste -s -d ','
-- Changes the list from newline-separated to comma-separated. I should also explain the sorting.
2>&1
-- Joins stderr and stdout.| fgrep '%'
-- Removes all output lines without a %
character.| sort -nr -k 4
-- Sorts the remaining lines in reverse numerical order by the 4th column (which is the column for coverage percentage). If you want normal order instead of reverse order, replace -nr
with -n
.Hope this helps someone! =)
touch __init__.py; nosetests --with-coverage --cover-package=`pwd | sed 's@.*/@@g'`
I would do this:
nosetests --with-coverage --cover-package=foo,bar tests/*
I prefer this solution to the others suggested; it's simple yet you are explicit about which packages you wish to have coverage for. Nadia's answer involves a lot more redundant typing, Stuart's answer uses sed and still creates a package by invoking touch __init__.py
, and
--cover-package=.
doesn't work for me.
For anyone trying to do this with setup.cfg, the following works. I had some trouble figuring out how to specify multiple packages.
[nosetests]
with-coverage=1
cover-html=1
cover-package=module1,module2
You can improve the accepted answer like so --cover-package=foo,bar
If you use coverage:py 3.0, then code in the Python directory is ignored by default, including the standard library and all installed packages.