summaryrefslogtreecommitdiff
path: root/coverage/runners/plugin.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2010-06-01 07:55:11 -0400
committerNed Batchelder <ned@nedbatchelder.com>2010-06-01 07:55:11 -0400
commita6bdf57239518ad149de626ec7c62c47393a85b3 (patch)
tree6ecc896f5c7ebe2bcfceae0d9d4524c3b694cfe6 /coverage/runners/plugin.py
parent9be47b1a910715e6a0803ac8b6c03aa8fe8f29d7 (diff)
downloadpython-coveragepy-git-a6bdf57239518ad149de626ec7c62c47393a85b3.tar.gz
Add some docstrings
Diffstat (limited to 'coverage/runners/plugin.py')
-rw-r--r--coverage/runners/plugin.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/coverage/runners/plugin.py b/coverage/runners/plugin.py
index 26bc9e7b..1ee946f1 100644
--- a/coverage/runners/plugin.py
+++ b/coverage/runners/plugin.py
@@ -13,6 +13,7 @@ class CoverageTestWrapper(object):
3) Run your tests
4) Call finish()
5) Improve your code coverage ;)
+
"""
coverPackages = None
@@ -29,6 +30,7 @@ class CoverageTestWrapper(object):
self.coverPackages = options.cover_package
def start(self):
+ """Start coverage before the test suite."""
# cover_omit is a ',' separated list if provided
self.omit = pattern_list(self.options.cover_omit)
self.include = pattern_list(self.options.cover_omit)
@@ -46,6 +48,7 @@ class CoverageTestWrapper(object):
self.coverage.start()
def finish(self, stream=None):
+ """Finish coverage after the test suite."""
self.coverage.stop()
self.coverage.save()
@@ -79,6 +82,7 @@ class CoverageTestWrapper(object):
return
def _want_module(self, name, module):
+ """Determine if this module should be reported on."""
for package in self.coverPackages:
if module is not None and name.startswith(package):
return True
@@ -86,7 +90,8 @@ class CoverageTestWrapper(object):
return False
-options = [
+# The command-line options for the plugin.
+OPTIONS = [
optparse.Option('--cover-rcfile', action='store', metavar="RCFILE",
help="Specify configuration file. ['.coveragerc']",
default=True),