src/reportlab/lib/pygments2xpre.py
author andy
Thu, 17 Dec 2009 16:18:34 +0000
changeset 3290 6e5e33a15a3d
parent 3289 58fcf065b4e0
child 3558 ae12a0645e9f
permissions -rw-r--r--
allowed lexer to be varied

"""Helps you output colourised code snippets in ReportLab documents.

Platypus has an 'XPreformatted' flowable for handling preformatted
text, with variations in fonts and colors.   If Pygments is installed,
calling 'pygments2xpre' will return content suitable for display in
an XPreformatted object.  If it's not installed, you won't get colours.

For a list of available lexers see http://pygments.org/docs/

"""
__all__ = ('pygments2xpre',)

def _2xpre(s,styles):
    "Helper to transform Pygments HTML output to ReportLab markup"
    s = s.replace('<div class="highlight">','')
    s = s.replace('</div>','')
    s = s.replace('<pre>','')
    s = s.replace('</pre>','')
    s = s.replace('</span>','</font>')
    for k,c in styles+[('p','#000000'),('n','#000000')]:
        s = s.replace('<span class="%s">' % k,'<font color="%s">' % c)
    return s

def pygments2xpre(s, language="python"):
    "Return markup suitable for XPreformatted"
    try:
        from pygments import highlight
        from pygments.formatters import HtmlFormatter
    except ImportError:
        return s

    from pygments.lexers import get_lexer_by_name

    l = get_lexer_by_name(language)
    
    h = HtmlFormatter()
    from StringIO import StringIO
    out = StringIO()
    highlight(s,l,h,out)
    styles = [(cls, style.split(';')[0].split(':')[1].strip())
                for cls, (style, ttype, level) in h.class2style.iteritems()
                if cls and style and style.startswith('color:')]
    return _2xpre(out.getvalue(),styles)


def convertSourceFiles(filenames):
    "Helper function - makes minimal PDF document"

    from reportlab.platypus import Paragraph, SimpleDocTemplate, Spacer, XPreformatted
    from reportlab.lib.styles import getSampleStyleSheet
    styT=getSampleStyleSheet()["Title"]
    styC=getSampleStyleSheet()["Code"]
    doc = SimpleDocTemplate("pygments2xpre.pdf")
    S = [].append
    for filename in filenames:
        S(Paragraph(filename,style=styT))
        src = open(filename, 'r').read()
        fmt = pygments2xpre(src)
        S(XPreformatted(fmt, style=styC))
    doc.build(S.__self__)
    print 'saved pygments2xpre.pdf'

if __name__=='__main__':
    import sys
    filenames = sys.argv[1:]
    if not filenames:
        print 'usage:  pygments2xpre.py file1.py [file2.py] [...]'
        sys.exit(0)
    convertSourceFiles(filenames)