This page lists all builtin formatters.
All formatters support these options:
If given, must be an encoding name (such as "utf-8"). This will be used to convert the token strings (which are Unicode strings) to byte strings in the output (default: None). It will also be written in an encoding declaration suitable for the document format if the full option is given (e.g. a meta content-type directive in HTML or an invocation of the inputenc package in LaTeX).
If this is "" or None, Unicode strings will be written to the output file, which most file-like objects do not support. For example, pygments.highlight() will return a Unicode string if called with no outfile argument and a formatter that has encoding set to None because it uses a StringIO.StringIO object that supports Unicode arguments to write(). Using a regular file object wouldn’t work.
New in version 0.6.
When using Pygments from the command line, any encoding option given is passed to the lexer and the formatter. This is sometimes not desirable, for example if you want to set the input encoding to "guess". Therefore, outencoding has been introduced which overrides encoding for the formatter if given.
New in version 0.7.
All these classes are importable from pygments.formatters.
Short names: | bbcode, bb |
---|---|
Filenames : | None |
Format tokens with BBcodes. These formatting codes are used by many bulletin boards, so you can highlight your sourcecode with pygments before posting it there.
This formatter has no support for background colors and borders, as there are no common BBcode tags for that.
Some board systems (e.g. phpBB) don’t support colors in their [code] tag, so you can’t use the highlighting together with that tag. Text in a [code] tag usually is shown with a monospace font (which this formatter can do with the monofont option) and no spaces (which you need for indentation) are removed.
Additional options accepted:
Short names: | bmp, bitmap |
---|---|
Filenames : | *.bmp |
Create a bitmap image from source code. This uses the Python Imaging Library to generate a pixmap from the source code.
New in version 1.0.
Short names: | gif |
---|---|
Filenames : | *.gif |
Create a GIF image from source code. This uses the Python Imaging Library to generate a pixmap from the source code.
New in version 1.0.
Short names: | html |
---|---|
Filenames : | *.html, *.htm |
Format tokens as HTML 4 <span> tags within a <pre> tag, wrapped in a <div> tag. The <div>‘s CSS class can be set by the cssclass option.
If the linenos option is set to "table", the <pre> is additionally wrapped inside a <table> which has one row and two cells: one containing the line numbers and one containing the code. Example:
<div class="highlight" >
<table><tr>
<td class="linenos" title="click to toggle"
onclick="with (this.firstChild.style)
{ display = (display == '') ? 'none' : '' }">
<pre>1
2</pre>
</td>
<td class="code">
<pre><span class="Ke">def </span><span class="NaFu">foo</span>(bar):
<span class="Ke">pass</span>
</pre>
</td>
</tr></table></div>
(whitespace added to improve clarity).
Wrapping can be disabled using the nowrap option.
A list of lines can be specified using the hl_lines option to make these lines highlighted (as of Pygments 0.11).
With the full option, a complete HTML 4 document is output, including the style definitions inside a <style> tag, or in a separate file if the cssfile option is given.
When tagsfile is set to the path of a ctags index file, it is used to generate hyperlinks from names to their definition. You must enable lineanchors and run ctags with the -n option for this to work. The python-ctags module from PyPI must be installed to use this feature; otherwise a RuntimeError will be raised.
The get_style_defs(arg=’‘) method of a HtmlFormatter returns a string containing CSS rules for the CSS classes used by the formatter. The argument arg can be used to specify additional CSS selectors that are prepended to the classes. A call fmter.get_style_defs(‘td .code’) would result in the following CSS classes:
td .code .kw { font-weight: bold; color: #00FF00 }
td .code .cm { color: #999999 }
...
If you have Pygments 0.6 or higher, you can also pass a list or tuple to the get_style_defs() method to request multiple prefixes for the tokens:
formatter.get_style_defs(['div.syntax pre', 'pre.syntax'])
The output would then look like this:
div.syntax pre .kw,
pre.syntax .kw { font-weight: bold; color: #00FF00 }
div.syntax pre .cm,
pre.syntax .cm { color: #999999 }
...
Additional options accepted:
CSS class for the wrapping <div> tag (default: 'highlight'). If you set this option, the default selector for get_style_defs() will be this class.
New in version 0.9: If you select the 'table' line numbers, the wrapping table will have a CSS class of this string plus 'table', the default is accordingly 'highlighttable'.
Inline CSS styles for the <pre> tag (default: '').
New in version 0.11.
If the full option is true and this option is given, it must be the name of an external file. If the filename does not include an absolute path, the file’s path will be assumed to be relative to the main output file’s path, if the latter can be found. The stylesheet is then written to this file instead of the HTML file.
New in version 0.6.
If cssfile is given and the specified file exists, the css file will not be overwritten. This allows the use of the full option in combination with a user specified css file. Default is False.
New in version 1.1.
If set to 'table', output line numbers as a table with two cells, one containing the line numbers, the other the whole code. This is copy-and-paste-friendly, but may cause alignment problems with some browsers or fonts. If set to 'inline', the line numbers will be integrated in the <pre> tag that contains the code (that setting is new in Pygments 0.8).
For compatibility with Pygments 0.7 and earlier, every true value except 'inline' means the same as 'table' (in particular, that means also True).
The default value is False, which means no line numbers at all.
Note: with the default (“table”) line number mechanism, the line numbers and code can have different line heights in Internet Explorer unless you give the enclosing <pre> tags an explicit line-height CSS property (you get the default line spacing with line-height: 125%).
Specify a list of lines to be highlighted.
New in version 0.11.
If set to True, the formatter won’t output the background color for the wrapping element (this automatically defaults to False when there is no wrapping element [eg: no argument for the get_syntax_defs method given]) (default: False).
New in version 0.6.
This string is output between lines of code. It defaults to "\n", which is enough to break a line inside <pre> tags, but you can e.g. set it to "<br>" to get HTML line breaks.
New in version 0.7.
If set to a nonempty string, e.g. foo, the formatter will wrap each output line in an anchor tag with a name of foo-linenumber. This allows easy linking to certain lines.
New in version 0.9.
If set to a nonempty string, e.g. foo, the formatter will wrap each output line in a span tag with an id of foo-linenumber. This allows easy access to lines via javascript.
New in version 1.6.
If set to the path of a ctags file, wrap names in anchor tags that link to their definitions. lineanchors should be used, and the tags file should specify line numbers (see the -n option to ctags).
New in version 1.6.
A string formatting pattern used to generate links to ctags definitions. Available variables are %(path)s, %(fname)s and %(fext)s. Defaults to an empty string, resulting in just #prefix-number links.
New in version 1.6.
A string used to generate a filename when rendering <pre> blocks, for example if displaying source code.
New in version 2.1.
Subclassing the HTML formatter
New in version 0.7.
The HTML formatter is now built in a way that allows easy subclassing, thus customizing the output HTML code. The format() method calls self._format_lines() which returns a generator that yields tuples of (1, line), where the 1 indicates that the line is a line of the formatted source code.
If the nowrap option is set, the generator is the iterated over and the resulting HTML is output.
Otherwise, format() calls self.wrap(), which wraps the generator with other generators. These may add some HTML code to the one generated by _format_lines(), either by modifying the lines generated by the latter, then yielding them again with (1, line), and/or by yielding other HTML code before or after the lines, with (0, html). The distinction between source lines and other code makes it possible to wrap the generator multiple times.
The default wrap() implementation adds a <div> and a <pre> tag.
A custom HtmlFormatter subclass could look like this:
class CodeHtmlFormatter(HtmlFormatter):
def wrap(self, source, outfile):
return self._wrap_code(source)
def _wrap_code(self, source):
yield 0, '<code>'
for i, t in source:
if i == 1:
# it's a line of formatted code
t += '<br>'
yield i, t
yield 0, '</code>'
This results in wrapping the formatted lines with a <code> tag, where the source lines are broken using <br> tags.
After calling wrap(), the format() method also adds the “line numbers” and/or “full document” wrappers if the respective options are set. Then, all HTML yielded by the wrapped generator is output.
Short names: | irc, IRC |
---|---|
Filenames : | None |
Format tokens with IRC color sequences
The get_style_defs() method doesn’t do anything special since there is no support for common styles.
Options accepted:
Short names: | img, IMG, png |
---|---|
Filenames : | *.png |
Create a PNG image from source code. This uses the Python Imaging Library to generate a pixmap from the source code.
New in version 0.10.
Additional options accepted:
An image format to output to that is recognised by PIL, these include:
The extra spacing (in pixels) between each line of text.
Default: 2
The font name to be used as the base font from which others, such as bold and italic fonts will be generated. This really should be a monospace font to look sane.
Default: “Bitstream Vera Sans Mono” on Windows, Courier New on *nix
The font size in points to be used.
Default: 14
The padding, in pixels to be used at each edge of the resulting image.
Default: 10
Whether line numbers should be shown: True/False
Default: True
The line number of the first line.
Default: 1
The step used when printing line numbers.
Default: 1
The background colour (in “#123456” format) of the line number bar, or None to use the style background color.
Default: “#eed”
The text color of the line numbers (in “#123456”-like format).
Default: “#886”
The number of columns of line numbers allowable in the line number margin.
Default: 2
Whether line numbers will be bold: True/False
Default: False
Whether line numbers will be italicized: True/False
Default: False
Whether a line will be drawn between the line number area and the source code area: True/False
Default: True
The horizontal padding (in pixels) between the line number margin, and the source code area.
Default: 6
Specify a list of lines to be highlighted.
New in version 1.2.
Default: empty list
Specify the color for highlighting lines.
New in version 1.2.
Default: highlight color of the selected style
Short names: | jpg, jpeg |
---|---|
Filenames : | *.jpg |
Create a JPEG image from source code. This uses the Python Imaging Library to generate a pixmap from the source code.
New in version 1.0.
Short names: | latex, tex |
---|---|
Filenames : | *.tex |
Format tokens as LaTeX code. This needs the fancyvrb and color standard packages.
Without the full option, code is formatted as one Verbatim environment, like this:
\begin{Verbatim}[commandchars=\\\{\}]
\PY{k}{def }\PY{n+nf}{foo}(\PY{n}{bar}):
\PY{k}{pass}
\end{Verbatim}
The special command used here (\PY) and all the other macros it needs are output by the get_style_defs method.
With the full option, a complete LaTeX document is output, including the command definitions in the preamble.
The get_style_defs() method of a LatexFormatter returns a string containing \def commands defining the macros needed inside the Verbatim environments.
Additional options accepted:
The LaTeX commands used to produce colored output are constructed using this prefix and some letters (default: 'PY').
New in version 0.7.
Changed in version 0.10: The default is now 'PY' instead of 'C'.
If set to True, enables LaTeX comment lines. That is, LaTex markup in comment tokens is not escaped so that LaTeX can render it (default: False).
New in version 1.2.
If set to True, enables LaTeX math mode escape in comments. That is, '$...$' inside a comment will trigger math mode (default: False).
New in version 1.2.
If set to a string of length 2, enables escaping to LaTeX. Text delimited by these 2 characters is read as LaTeX code and typeset accordingly. It has no effect in string literals. It has no effect in comments if texcomments or mathescape is set. (default: '').
New in version 2.0.
Allows you to pick an alternative environment name replacing Verbatim. The alternate environment still has to support Verbatim’s option syntax. (default: 'Verbatim').
New in version 2.0.
Short names: | text, null |
---|---|
Filenames : | *.txt |
Output the text unchanged without any formatting.
Short names: | raw, tokens |
---|---|
Filenames : | *.raw |
Format tokens as a raw representation for storing token streams.
The format is tokentype<TAB>repr(tokenstring)\n. The output can later be converted to a token stream with the RawTokenLexer, described in the lexer list.
Only two options are accepted:
If set to a color name, highlight error tokens using that color. If set but with no value, defaults to 'red'.
New in version 0.11.
Short names: | rtf |
---|---|
Filenames : | *.rtf |
Format tokens as RTF markup. This formatter automatically outputs full RTF documents with color information and other useful stuff. Perfect for Copy and Paste into Microsoft(R) Word(R) documents.
Please note that encoding and outencoding options are ignored. The RTF format is ASCII natively, but handles unicode characters correctly thanks to escape sequences.
New in version 0.6.
Additional options accepted:
Size of the font used. Size is specified in half points. The default is 24 half-points, giving a size 12 font.
New in version 2.0.
Short names: | svg |
---|---|
Filenames : | *.svg |
Format tokens as an SVG graphics file. This formatter is still experimental. Each line of code is a <text> element with explicit x and y coordinates containing <tspan> elements with the individual token styles.
By default, this formatter outputs a full SVG document including doctype declaration and the <svg> root element.
New in version 0.9.
Additional options accepted:
Short names: | terminal256, console256, 256 |
---|---|
Filenames : | None |
Format tokens with ANSI color sequences, for output in a 256-color terminal or console. Like in TerminalFormatter color sequences are terminated at newlines, so that paging the output works correctly.
The formatter takes colors from a style defined by the style option and converts them to nearest ANSI 256-color escape sequences. Bold and underline attributes from the style are preserved (and displayed).
New in version 0.9.
Options accepted:
Short names: | terminal, console |
---|---|
Filenames : | None |
Format tokens with ANSI color sequences, for output in a text console. Color sequences are terminated at newlines, so that paging the output works correctly.
The get_style_defs() method doesn’t do anything special since there is no support for common styles.
Options accepted:
Short names: | terminal16m, console16m, 16m |
---|---|
Filenames : | None |
Format tokens with ANSI color sequences, for output in a true-color terminal or console. Like in TerminalFormatter color sequences are terminated at newlines, so that paging the output works correctly.
New in version 2.1.
Options accepted:
Short names: | testcase |
---|---|
Filenames : | None |
Format tokens as appropriate for a new testcase.
New in version 2.0.