diff options
| author | Raymond Hettinger <python@rcn.com> | 2012-07-03 07:12:27 (GMT) |
|---|---|---|
| committer | Raymond Hettinger <python@rcn.com> | 2012-07-03 07:12:27 (GMT) |
| commit | cf6eac40639ef64fe07a83abd313dab06a45a1e1 (patch) | |
| tree | 39786a6a47386343e075ad281b04594c4f7184e9 /Tools/scripts/highlight.py | |
| parent | ecea0fb1739d4a85a235cee6013747742d9e9acb (diff) | |
| download | cpython-cf6eac40639ef64fe07a83abd313dab06a45a1e1.zip cpython-cf6eac40639ef64fe07a83abd313dab06a45a1e1.tar.gz cpython-cf6eac40639ef64fe07a83abd313dab06a45a1e1.tar.bz2 | |
Minor cleanups
Diffstat (limited to 'Tools/scripts/highlight.py')
| -rwxr-xr-x | Tools/scripts/highlight.py | 127 |
1 files changed, 127 insertions, 0 deletions
diff --git a/Tools/scripts/highlight.py b/Tools/scripts/highlight.py new file mode 100755 index 0000000..85ce091 --- /dev/null +++ b/Tools/scripts/highlight.py @@ -0,0 +1,127 @@ +#!/usr/bin/env python3 +'Convert Python source code to HTML with colorized markup' + +__all__ = ['colorize', 'build_page', 'default_css', 'default_html'] +__author__ = 'Raymond Hettinger' + +import keyword, tokenize, cgi, functools + +def is_builtin(s): + 'Return True if s is the name of a builtin' + return s in vars(__builtins__) + +def escape_range(lines, start, end): + 'Return escaped content from a range of lines between start and end' + (srow, scol), (erow, ecol) = start, end + if srow == erow: + rows = [lines[srow-1][scol:ecol]] + else: + rows = [lines[srow-1][scol:]] + lines[srow: erow-1] + [lines[erow-1][:ecol]] + return cgi.escape(''.join(rows)), end + +def colorize(source): + 'Convert Python source code to an HTML fragment with colorized markup' + lines = source.splitlines(keepends=True) + lines.append('') + readline = functools.partial(next, iter(lines), '') + kind = tok_str = '' + tok_type = tokenize.COMMENT + written = (1, 0) + result = [] + for tok in tokenize.generate_tokens(readline): + prev_tok_type, prev_tok_str = tok_type, tok_str + tok_type, tok_str, (srow, scol), (erow, ecol), logical_lineno = tok + kind = '' + if tok_type == tokenize.COMMENT: + kind = 'comment' + elif tok_type == tokenize.OP and tok_str[:1] not in '{}[](),.:;': + kind = 'operator' + elif tok_type == tokenize.STRING: + kind = 'string' + if prev_tok_type == tokenize.INDENT or scol==0: + kind = 'docstring' + elif tok_type == tokenize.NAME: + if tok_str in ('def', 'class', 'import', 'from'): + kind = 'definition' + elif prev_tok_str in ('def', 'class'): + kind = 'defname' + elif keyword.iskeyword(tok_str): + kind = 'keyword' + elif is_builtin(tok_str) and prev_tok_str != '.': + kind = 'builtin' + if kind: + line_upto_token, written = escape_range(lines, written, (srow, scol)) + line_thru_token, written = escape_range(lines, written, (erow, ecol)) + result += [line_upto_token, '<span class="%s">' % kind, + line_thru_token, '</span>'] + else: + line_thru_token, written = escape_range(lines, written, (erow, ecol)) + result += [line_thru_token] + + result.insert(0, '<pre class="python">\n') + result.append('</pre>\n') + return ''.join(result) + +default_css = { + '.comment': '{color: crimson;}', + '.string': '{color: forestgreen;}', + '.docstring': '{color: forestgreen; font-style:italic}', + '.keyword': '{color: darkorange;}', + '.builtin': '{color: purple;}', + '.definition': '{color: darkorange; font-weight:bold;}', + '.defname': '{color: blue;}', + '.operator': '{color: brown;}', +} + +default_html = '''\ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" + "http://www.w3.org/TR/html4/strict.dtd"> +<html> +<head> +<meta http-equiv="Content-type" content="text/html;charset=UTF-8"> +<title> {title} </title> +<style type="text/css"> +{css} +</style> +</head> +<body> +{body} +</body> +</html> +''' + +def build_page(source, title='python', css=default_css, html=default_html): + 'Create a complete HTML page with colorized Python source code' + css_str = '\n'.join(['%s %s' % item for item in css.items()]) + result = colorize(source) + title = cgi.escape(title) + return html.format(title=title, css=css_str, body=result) + + +if __name__ == '__main__': + import sys, argparse, webbrowser, os + + parser = argparse.ArgumentParser( + description = 'Convert Python source code to colorized HTML') + parser.add_argument('sourcefile', metavar = 'SOURCEFILE', + help = 'File containing Python sourcecode') + parser.add_argument('-b', '--browser', action = 'store_true', + help = 'launch a browser to show results') + parser.add_argument('-s', '--section', action = 'store_true', + help = 'show an HTML section rather than a complete webpage') + args = parser.parse_args() + if args.browser and args.section: + parser.error('The -s/--section option is incompatible with ' + 'the -b/--browser option') + + sourcefile = args.sourcefile + with open(sourcefile) as f: + page = f.read() + html = colorize(page) if args.section else build_page(page, title=sourcefile) + if args.browser: + htmlfile = os.path.splitext(os.path.basename(sourcefile))[0] + '.html' + with open(htmlfile, 'w') as f: + f.write(html) + webbrowser.open('file://' + os.path.abspath(htmlfile)) + else: + sys.stdout.write(html) |