pygments

package documentation

Pygments is a syntax highlighting package written in Python.

It is a generic syntax highlighter for general use in all kinds of software such as forum systems, wikis or other applications that need to prettify source code. Highlights are:

  • a wide range of common languages and markup formats is supported
  • special attention is paid to details, increasing quality by a fair amount
  • support for new languages and formats are added easily
  • a number of output formats, presently HTML, LaTeX, RTF, SVG, all image formats that PIL supports, and ANSI sequences
  • it is usable as a command-line tool and as a library
  • ... and it highlights even Brainfuck!

The Pygments master branch is installable with easy_install Pygments==dev.

Unknown Field: copyright
Copyright 2006-2021 by the Pygments team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Module formatter pygments.formatter ~~~~~~~~~~~~~~~~~~
Package formatters pygments.formatters ~~~~~~~~~~~~~~~~~~~
Module lexer pygments.lexer ~~~~~~~~~~~~~~
Package lexers pygments.lexers ~~~~~~~~~~~~~~~
Package styles pygments.styles ~~~~~~~~~~~~~~~
Module token pygments.token ~~~~~~~~~~~~~~
Module util pygments.util ~~~~~~~~~~~~~
Module __main__ pygments.__main__ ~~~~~~~~~~~~~~~~~
Module cmdline pygments.cmdline ~~~~~~~~~~~~~~~~
Module console pygments.console ~~~~~~~~~~~~~~~~
Module filter pygments.filter ~~~~~~~~~~~~~~~
Package filters pygments.filters ~~~~~~~~~~~~~~~~
Module modeline pygments.modeline ~~~~~~~~~~~~~~~~~
Module plugin pygments.plugin ~~~~~~~~~~~~~~~
Module regexopt pygments.regexopt ~~~~~~~~~~~~~~~~~
Module scanner pygments.scanner ~~~~~~~~~~~~~~~~
Module sphinxext pygments.sphinxext ~~~~~~~~~~~~~~~~~~
Module style pygments.style ~~~~~~~~~~~~~~
Module unistring pygments.unistring ~~~~~~~~~~~~~~~~~~

From __init__.py:

Function format Format a tokenlist tokens with the formatter formatter.
Function highlight Lex code with lexer and format it with the formatter formatter.
Function lex Lex code with lexer and return an iterable of tokens.
Variable __version__ Undocumented
__version__: str =

Undocumented

def lex(code, lexer):
Lex code with lexer and return an iterable of tokens.
def format(tokens, formatter, outfile=None):

Format a tokenlist tokens with the formatter formatter.

If outfile is given and a valid file object (an object with a write method), the result will be written to it, otherwise it is returned as a string.

def highlight(code, lexer, formatter, outfile=None):

Lex code with lexer and format it with the formatter formatter.

If outfile is given and a valid file object (an object with a write method), the result will be written to it, otherwise it is returned as a string.