summaryrefslogtreecommitdiff
path: root/coverage/report.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2010-05-15 23:03:52 -0400
committerNed Batchelder <ned@nedbatchelder.com>2010-05-15 23:03:52 -0400
commitf0b3451e829de7311c39a18c0fb34312330981ef (patch)
tree18d749a0434445f0316ecc7b641739b2796e268b /coverage/report.py
parent4fb69b6c13c00bba910afe9d6beade673f4e4386 (diff)
downloadpython-coveragepy-git-f0b3451e829de7311c39a18c0fb34312330981ef.tar.gz
Format the code to pylint's liking, and fix up the docstrings for omit and include.
Diffstat (limited to 'coverage/report.py')
-rw-r--r--coverage/report.py21
1 files changed, 10 insertions, 11 deletions
diff --git a/coverage/report.py b/coverage/report.py
index 9e6b29d8..a676e186 100644
--- a/coverage/report.py
+++ b/coverage/report.py
@@ -26,18 +26,18 @@ class Reporter(object):
def find_code_units(self, morfs, omit_prefixes, include_prefixes):
"""Find the code units we'll report on.
+
`morfs` is a list of modules or filenames. `omit_prefixes` is a list
of prefixes to leave out of the list.
- `omit_prefixes` is a list of prefixes. CodeUnits that match those prefixes
- will be omitted from the list.
- `include_prefixes` is a list of prefixes. Only CodeUnits that match those prefixes
- will be included in the list.
- You are required to pass at most one of `omit_prefixes` and `include_prefixes`.
+ See `coverage.report()` for other arguments.
+
"""
morfs = morfs or self.coverage.data.executed_files()
self.code_units = code_unit_factory(
- morfs, self.coverage.file_locator, omit_prefixes, include_prefixes)
+ morfs, self.coverage.file_locator, omit_prefixes,
+ include_prefixes
+ )
self.code_units.sort()
def report_files(self, report_fn, morfs, directory=None,
@@ -46,11 +46,10 @@ class Reporter(object):
`report_fn` is called for each relative morf in `morfs`.
- `omit_prefixes` is a list of prefixes. CodeUnits that match those prefixes
- will be omitted from the list.
- `include_prefixes` is a list of prefixes. Only CodeUnits that match those prefixes
- will be included in the list.
- You are required to pass at most one of `omit_prefixes` and `include_prefixes`.
+ `include_prefixes` is a list of filename prefixes. CodeUnits that match
+ those prefixes will be included in the list. CodeUnits that match
+ `omit_prefixes` will be omitted from the list.
+
"""
self.find_code_units(morfs, omit_prefixes, include_prefixes)