nose-cov
========
This plugin produces coverage reports. It also supports coverage of subprocesses.
All features offered by the coverage package should be available, either through nose-cov or
through coverage's config file.
Installation
------------
Install with pip::
pip install nose-cov
.. NOTE::
Ensure you use pip instead of easy_install as the latter does not correctly install the
init_cov_core.pth file needed for subprocess measurement.
Uninstallation
--------------
Uninstall with pip::
pip uninstall nose-cov
pip uninstall cov-core
.. NOTE::
Ensure that you manually delete the init_cov_core.pth file in your site-packages directory.
This file starts coverage collection of subprocesses if appropriate during site initialisation
at python startup.
Usage
-----
The following will report on the combined coverage of the main process and all of it's subprocesses::
nosetests --with-cov --cov myproj tests/
Shows a terminal report::
---------- coverage: platform linux2, python 2.6.5-final-0 -----------
Name Stmts Miss Cover
----------------------------------------
myproj/__init__ 2 0 100%
myproj/myproj 257 13 95%
myproj/feature4286 94 9 90%
----------------------------------------
TOTAL 353 22 94%
----------------------------------------------------------------------
Reporting
---------
It is possible to generate any combination of the reports for a single test run.
The available reports are terminal (with or without missing line numbers shown), HTML, XML and
annotated source code.
The terminal report without line numbers (default)::
nosetests --with-cov --cov-report term --cov myproj tests/
---------- coverage: platform linux2, python 2.6.5-final-0 -----------
Name Stmts Miss Cover
----------------------------------------
myproj/__init__ 2 0 100%
myproj/myproj 257 13 95%
myproj/feature4286 94 9 90%
----------------------------------------
TOTAL 353 22 94%
----------------------------------------------------------------------
The terminal report with line numbers::
nosetests --with-cov --cov-report term-missing --cov myproj tests/
---------- coverage: platform linux2, python 2.6.5-final-0 -----------
Name Stmts Miss Cover Missing
--------------------------------------------------
myproj/__init__ 2 0 100%
myproj/myproj 257 13 95% 24-26, 99, 149, 233-236, 297-298, 369-370
myproj/feature4286 94 9 90% 37, 40, 183-188, 197
--------------------------------------------------
TOTAL 353 22 94%
----------------------------------------------------------------------
The remaining three reports output to files without showing anything on the terminal (useful for
when the output is going to a continuous integration server)::
nosetests --with-cov
--cov-report html
--cov-report xml
--cov-report annotate
--cov myproj tests/
Coverage Data File
------------------
The data file is erased at the beginning of testing to ensure clean data for each test run.
The data file is left at the end of testing so that it is possible to use normal coverage tools to
examine it.
Coverage Config File
--------------------
This plugin provides a clean minimal set of command line options that are added to nosetests. For
further control of coverage use a coverage config file.
For example if tests are contained within the directory tree being measured the tests may be
excluded if desired by using a .coveragerc file with the omit option set::
nosetests --cov-config .coveragerc
--cov myproj
myproj/tests/
Where the .coveragerc file contains file globs::
[run]
omit = tests/*
For full details refer to the `coverage config file`_ documentation.
.. _`coverage config file`: http://nedbatchelder.com/code/coverage/config.html
Note that this plugin controls some options and setting the option in the config file will have no
effect. These include specifying source to be measured (source option) and all data file handling
(data_file and parallel options).
Limitations
-----------
For subprocess measurement environment variables must make it from the main process to the
subprocess. The python used by the subprocess must have nose-cov installed. The subprocess must
do normal site initialisation so that the environment variables can be detected and coverage
started.
Nose Multiprocess Plugin
------------------------
The nose cov plugin partially works with the nose multiprocess plugin.
The nose multiprocess plugin does not join with its child processes so nose cov plugin has coverage
measured but can't merge coverage results and report them.
Work around by using cov plugin and multiprocess plugin together to run tests, note coverage report
from this command will be incorrect::
nosetests --with-cov --processes=4 tests/
After there will be coverage data files for the main nose process and each subprocess::
.coverage
.coverage.hostname.7323.198266
.coverage.hostname.7339.177156
.coverage.hostname.7358.543616
.coverage.hostname.7393.997428
Tell coverage to merge coverage results into one coverage data file::
coverage combine
Tell coverage to report::
coverage report
Acknowledgements
----------------
Whilst this plugin has been built fresh from the ground up it has been influenced by the work done
on pytest-coverage (Ross Lawley, James Mills, Holger Krekel) and nose-cover (Jason Pellerin) which are
other coverage plugins.
Ned Batchelder for coverage and its ability to combine the coverage results of parallel runs.
Holger Krekel for pytest with its distributed testing support.
Jason Pellerin for nose.
Michael Foord for unittest2.
No doubt others have contributed to these tools as well.
Raw data
{
"_id": null,
"home_page": "http://bitbucket.org/memedough/nose-cov/overview",
"name": "nose-cov",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "nose nosetest cover coverage",
"author": "Meme Dough",
"author_email": "memedough@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/60/f0/df0b502f5acd0c57d93251ec04c2676d582bbb2f7bb86f5debcdf6ca702a/nose-cov-1.6.tar.gz",
"platform": "UNKNOWN",
"description": "nose-cov\n========\n\nThis plugin produces coverage reports. It also supports coverage of subprocesses.\n\nAll features offered by the coverage package should be available, either through nose-cov or\nthrough coverage's config file.\n\n\nInstallation\n------------\n\nInstall with pip::\n\n pip install nose-cov\n\n.. NOTE::\n\n Ensure you use pip instead of easy_install as the latter does not correctly install the\n init_cov_core.pth file needed for subprocess measurement.\n\n\nUninstallation\n--------------\n\nUninstall with pip::\n\n pip uninstall nose-cov\n pip uninstall cov-core\n\n.. NOTE::\n\n Ensure that you manually delete the init_cov_core.pth file in your site-packages directory.\n\n This file starts coverage collection of subprocesses if appropriate during site initialisation\n at python startup.\n\n\nUsage\n-----\n\nThe following will report on the combined coverage of the main process and all of it's subprocesses::\n\n nosetests --with-cov --cov myproj tests/\n\nShows a terminal report::\n\n ---------- coverage: platform linux2, python 2.6.5-final-0 -----------\n Name Stmts Miss Cover\n ----------------------------------------\n myproj/__init__ 2 0 100%\n myproj/myproj 257 13 95%\n myproj/feature4286 94 9 90%\n ----------------------------------------\n TOTAL 353 22 94%\n ----------------------------------------------------------------------\n\n\nReporting\n---------\n\nIt is possible to generate any combination of the reports for a single test run.\n\nThe available reports are terminal (with or without missing line numbers shown), HTML, XML and\nannotated source code.\n\nThe terminal report without line numbers (default)::\n\n nosetests --with-cov --cov-report term --cov myproj tests/\n\n ---------- coverage: platform linux2, python 2.6.5-final-0 -----------\n Name Stmts Miss Cover\n ----------------------------------------\n myproj/__init__ 2 0 100%\n myproj/myproj 257 13 95%\n myproj/feature4286 94 9 90%\n ----------------------------------------\n TOTAL 353 22 94%\n ----------------------------------------------------------------------\n\n\nThe terminal report with line numbers::\n\n nosetests --with-cov --cov-report term-missing --cov myproj tests/\n\n ---------- coverage: platform linux2, python 2.6.5-final-0 -----------\n Name Stmts Miss Cover Missing\n --------------------------------------------------\n myproj/__init__ 2 0 100%\n myproj/myproj 257 13 95% 24-26, 99, 149, 233-236, 297-298, 369-370\n myproj/feature4286 94 9 90% 37, 40, 183-188, 197\n --------------------------------------------------\n TOTAL 353 22 94%\n ----------------------------------------------------------------------\n\n\nThe remaining three reports output to files without showing anything on the terminal (useful for\nwhen the output is going to a continuous integration server)::\n\n nosetests --with-cov\n --cov-report html\n --cov-report xml\n --cov-report annotate\n --cov myproj tests/\n\n\nCoverage Data File\n------------------\n\nThe data file is erased at the beginning of testing to ensure clean data for each test run.\n\nThe data file is left at the end of testing so that it is possible to use normal coverage tools to\nexamine it.\n\n\nCoverage Config File\n--------------------\n\nThis plugin provides a clean minimal set of command line options that are added to nosetests. For\nfurther control of coverage use a coverage config file.\n\nFor example if tests are contained within the directory tree being measured the tests may be\nexcluded if desired by using a .coveragerc file with the omit option set::\n\n nosetests --cov-config .coveragerc\n --cov myproj\n myproj/tests/\n\nWhere the .coveragerc file contains file globs::\n\n [run]\n omit = tests/*\n\nFor full details refer to the `coverage config file`_ documentation.\n\n.. _`coverage config file`: http://nedbatchelder.com/code/coverage/config.html\n\nNote that this plugin controls some options and setting the option in the config file will have no\neffect. These include specifying source to be measured (source option) and all data file handling\n(data_file and parallel options).\n\n\nLimitations\n-----------\n\nFor subprocess measurement environment variables must make it from the main process to the\nsubprocess. The python used by the subprocess must have nose-cov installed. The subprocess must\ndo normal site initialisation so that the environment variables can be detected and coverage\nstarted.\n\n\nNose Multiprocess Plugin\n------------------------\n\nThe nose cov plugin partially works with the nose multiprocess plugin.\n\nThe nose multiprocess plugin does not join with its child processes so nose cov plugin has coverage\nmeasured but can't merge coverage results and report them.\n\nWork around by using cov plugin and multiprocess plugin together to run tests, note coverage report\nfrom this command will be incorrect::\n\n nosetests --with-cov --processes=4 tests/\n\nAfter there will be coverage data files for the main nose process and each subprocess::\n\n .coverage\n .coverage.hostname.7323.198266\n .coverage.hostname.7339.177156\n .coverage.hostname.7358.543616\n .coverage.hostname.7393.997428\n\nTell coverage to merge coverage results into one coverage data file::\n\n coverage combine\n\n\nTell coverage to report::\n\n coverage report\n\n\nAcknowledgements\n----------------\n\nWhilst this plugin has been built fresh from the ground up it has been influenced by the work done\non pytest-coverage (Ross Lawley, James Mills, Holger Krekel) and nose-cover (Jason Pellerin) which are\nother coverage plugins.\n\nNed Batchelder for coverage and its ability to combine the coverage results of parallel runs.\n\nHolger Krekel for pytest with its distributed testing support.\n\nJason Pellerin for nose.\n\nMichael Foord for unittest2.\n\nNo doubt others have contributed to these tools as well.",
"bugtrack_url": null,
"license": "MIT License",
"summary": "nose plugin for coverage reporting, including subprocesses and multiprocessing",
"version": "1.6",
"split_keywords": [
"nose",
"nosetest",
"cover",
"coverage"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "606c873acdccc331a6d5acd681e97ef9",
"sha256": "8bec0335598f1cc69e3262cc50d7678c1a6010fa44625ce343c4ec1500774412"
},
"downloads": -1,
"filename": "nose-cov-1.6.tar.gz",
"has_sig": false,
"md5_digest": "606c873acdccc331a6d5acd681e97ef9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5352,
"upload_time": "2012-09-01T06:23:44",
"upload_time_iso_8601": "2012-09-01T06:23:44.579556Z",
"url": "https://files.pythonhosted.org/packages/60/f0/df0b502f5acd0c57d93251ec04c2676d582bbb2f7bb86f5debcdf6ca702a/nose-cov-1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2012-09-01 06:23:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "nose-cov"
}
JSON