pygments.formatter.Formatter Class Reference

Inheritance diagram for pygments.formatter.Formatter:

Public Member Functions
	__init__ (self, **options)
	get_style_defs (self, arg='')
	format (self, tokensource, outfile)
	__class_getitem__ (cls, name)

Public Attributes
	style
	full
	title
	encoding
	options

Static Public Attributes
	name = None
list	aliases = []
list	filenames = []
bool	unicodeoutput = True

Detailed Description

Converts a token stream to text.

Formatters should have attributes to help selecting them. These
are similar to the corresponding :class:`~pygments.lexer.Lexer`
attributes.

.. autoattribute:: name
   :no-value:

.. autoattribute:: aliases
   :no-value:

.. autoattribute:: filenames
   :no-value:

You can pass options as keyword arguments to the constructor.
All formatters accept these basic options:

``style``
    The style to use, can be a string or a Style subclass
    (default: "default"). Not used by e.g. the
    TerminalFormatter.
``full``
    Tells the formatter to output a "full" document, i.e.
    a complete self-contained document. This doesn't have
    any effect for some formatters (default: false).
``title``
    If ``full`` is true, the title that should be used to
    caption the document (default: '').
``encoding``
    If given, must be an encoding name. This will be used to
    convert the Unicode token strings to byte strings in the
    output. If it is "" or None, Unicode strings will be written
    to the output file, which most file-like objects do not
    support (default: None).
``outencoding``
    Overrides ``encoding`` if given.

Constructor & Destructor Documentation

__init__()

pygments.formatter.Formatter.__init__	(		self,
		**	options
	)

As with lexers, this constructor takes arbitrary optional arguments,
and if you override it, you should first process your own options, then
call the base class implementation.

Reimplemented in pygments.formatters.bbcode.BBCodeFormatter, pygments.formatters.groff.GroffFormatter, pygments.formatters.html.HtmlFormatter, pygments.formatters.img.ImageFormatter, pygments.formatters.irc.IRCFormatter, pygments.formatters.latex.LatexFormatter, pygments.formatters.other.RawTokenFormatter, pygments.formatters.other.TestcaseFormatter, pygments.formatters.pangomarkup.PangoMarkupFormatter, pygments.formatters.rtf.RtfFormatter, pygments.formatters.svg.SvgFormatter, pygments.formatters.terminal.TerminalFormatter, pygments.formatters.terminal256.Terminal256Formatter, and docutils.writers.odf_odt.pygmentsformatter.OdtPygmentsFormatter.

Member Function Documentation

format()

pygments.formatter.Formatter.format	(		self,
			tokensource,
			outfile
	)

This method must format the tokens from the `tokensource` iterable and
write the formatted version to the file object `outfile`.

Formatter options can control how exactly the tokens are converted.

Reimplemented in docutils.writers.odf_odt.pygmentsformatter.OdtPygmentsProgFormatter, docutils.writers.odf_odt.pygmentsformatter.OdtPygmentsLaTeXFormatter, pygments.formatters.img.ImageFormatter, pygments.formatters.other.NullFormatter, pygments.formatters.other.RawTokenFormatter, pygments.formatters.other.TestcaseFormatter, pygments.formatters.terminal.TerminalFormatter, and pygments.formatters.terminal256.Terminal256Formatter.

get_style_defs()

pygments.formatter.Formatter.get_style_defs	(		self,
			arg = ''
	)

This method must return statements or declarations suitable to define
the current style for subsequent highlighted text (e.g. CSS classes
in the `HTMLFormatter`).

The optional argument `arg` can be used to modify the generation and
is formatter dependent (it is standardized because it can be given on
the command line).

This method is called by the ``-S`` :doc:`command-line option <cmdline>`,
the `arg` is then given by the ``-a`` option.

Reimplemented in pygments.formatters.img.ImageFormatter, pygments.formatters.latex.LatexFormatter, and pygments.formatters.html.HtmlFormatter.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pygments/formatter.py