diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2009-04-20 09:13:14 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2009-04-20 09:13:14 -0400 |
| commit | 6aae48656f456ec0cbdf7add2be7a26de63200af (patch) | |
| tree | 386c092865d82b26f8616dea9e2e6ed5df6b1f76 /coverage/html.py | |
| parent | 5d1cdd285721375e0973bf37f6504aefb1a8d74d (diff) | |
| download | python-coveragepy-6aae48656f456ec0cbdf7add2be7a26de63200af.tar.gz | |
HTML reporting, phase 0.
Diffstat (limited to 'coverage/html.py')
| -rw-r--r-- | coverage/html.py | 132 |
1 files changed, 132 insertions, 0 deletions
diff --git a/coverage/html.py b/coverage/html.py new file mode 100644 index 0000000..f0a9447 --- /dev/null +++ b/coverage/html.py @@ -0,0 +1,132 @@ +"""HTML reporting for coverage.py""" + +import os +from coverage.report import Reporter +from coverage.templite import Templite + +class HtmlReporter(Reporter): + """HTML reporting. + + """ + + def __init__(self, coverage, ignore_errors=False): + super(HtmlReporter, self).__init__(coverage, ignore_errors) + self.directory = None + self.source_tmpl = Templite(SOURCE, globals()) + + def report(self, morfs, directory=None, omit_prefixes=None): + assert directory, "must provide a directory for html reporting" + self.report_files(self.html_file, morfs, directory, omit_prefixes) + + def html_file(self, cu, statements, excluded, missing): + """Generate an HTML file for one source file.""" + + lines = [] + source = cu.source_file() + for lineno, line in enumerate(source.readlines()): + lineno += 1 + + css_class = "" + if lineno in statements: + css_class += " s" + if lineno not in missing and lineno not in excluded: + css_class += " r" + if lineno in excluded: + css_class += " x" + if lineno in missing: + css_class += " m" + + lineinfo = { + 'text': line, + 'number': lineno, + 'class': css_class.strip() or "p" + } + lines.append(lineinfo) + + html_filename = os.path.join(self.directory, cu.flat_rootname()) + ".html" + fhtml = open(html_filename, 'w') + fhtml.write(self.source_tmpl.render(locals())) + fhtml.close() + + + +# Helpers for templates + +def escape(t): + """HTML-escape the text in t.""" + return ( + t.replace("&", "&").replace("<", "<").replace(">", ">") + .replace("'", "'").replace('"', """) + .replace(" ", " ") + ) + +def not_empty(t): + """Make sure HTML content is not completely empty.""" + return t or " " + + +# Templates + +SOURCE = """\ +<html> +<head> +<title>Coverage of {{cu.filename|escape}}</title> +<style> +* { + font-size: 11pt; + line-height: 1.1em; + } +.linenos { + background: #eee; + } +.linenos p { + text-align: right; + margin: 0; + padding: 0 .5em 0 0; + font-family: verdana, sans-serif; + } +.source p { + margin: 0; + padding: 0 0 0 .5em; + font-family: "courier new", monospace; + } + +.linenos p.m { + background: #fcc; + } +.linenos p.r { + background: #cfc; + } +.linenos p.x { + background: #ddd; + } + +.source p.m { + background: #fee; + } +.source p.r { + background: #efe; + } +.source p.x { + background: #eee; + } +</style> +</head> +<body> +<table cellspacing='0' cellpadding='0'> +<tr> +<td class='linenos' valign='top'> + {% for line in lines %} + <p class='{{line.class}}'>{{line.number}}</p> + {% endfor %} +</td> +<td class='source' valign='top'> + {% for line in lines %} + <p class='{{line.class}}'>{{line.text.rstrip|escape|not_empty}}</p> + {% endfor %} +</td> +</tr> +</table> +</body> +</html> +""" |