pygments.formatters Namespace Reference

Namespaces
namespace	bbcode
namespace	groff
namespace	html
namespace	img
namespace	irc
namespace	latex
namespace	other
namespace	pangomarkup
namespace	rtf
namespace	svg
namespace	terminal
namespace	terminal256

Classes
class	_automodule

Functions
	_fn_matches (fn, glob)
	_load_formatters (module_name)
	get_all_formatters ()
	find_formatter_class (alias)
	get_formatter_by_name (_alias, **options)
	load_formatter_from_file (filename, formattername="CustomFormatter", **options)
	get_formatter_for_filename (fn, **options)

Variables
dict	_formatter_cache = {}
dict	_pattern_cache = {}
	oldmod = sys.modules[__name__]
	newmod = _automodule(__name__)

Detailed Description

    pygments.formatters
    ~~~~~~~~~~~~~~~~~~~

    Pygments formatters.

    :copyright: Copyright 2006-2025 by the Pygments team, see AUTHORS.
    :license: BSD, see LICENSE for details.

Function Documentation

_fn_matches()

pygments.formatters._fn_matches (   fn,   glob  )

protected

Return whether the supplied file name fn matches pattern filename.

_load_formatters()

pygments.formatters._load_formatters (   module_name )

protected

Load a formatter (and all others in the module too).

find_formatter_class()

pygments.formatters.find_formatter_class

(

alias

)

Lookup a formatter by alias.

Returns None if not found.

get_all_formatters()

pygments.formatters.get_all_formatters

(

)

Return a generator for all formatter classes.

get_formatter_by_name()

pygments.formatters.get_formatter_by_name	(		_alias,
		**	options
	)

Return an instance of a :class:`.Formatter` subclass that has `alias` in its
aliases list. The formatter is given the `options` at its instantiation.

Will raise :exc:`pygments.util.ClassNotFound` if no formatter with that
alias is found.

get_formatter_for_filename()

pygments.formatters.get_formatter_for_filename	(		fn,
		**	options
	)

Return a :class:`.Formatter` subclass instance that has a filename pattern
matching `fn`. The formatter is given the `options` at its instantiation.

Will raise :exc:`pygments.util.ClassNotFound` if no formatter for that filename
is found.

load_formatter_from_file()

pygments.formatters.load_formatter_from_file	(		filename,
			formattername = "CustomFormatter",
		**	options
	)

Return a `Formatter` subclass instance loaded from the provided file, relative
to the current directory.

The file is expected to contain a Formatter class named ``formattername``
(by default, CustomFormatter). Users should be very careful with the input, because
this method is equivalent to running ``eval()`` on the input file. The formatter is
given the `options` at its instantiation.

:exc:`pygments.util.ClassNotFound` is raised if there are any errors loading
the formatter.

.. versionadded:: 2.2