pygments.filters Namespace Reference

Classes
class	CodeTagFilter
class	ErrorToken
class	GobbleFilter
class	KeywordCaseFilter
class	NameHighlightFilter
class	RaiseOnErrorTokenFilter
class	SymbolFilter
class	TokenMergeFilter
class	VisibleWhitespaceFilter

Functions
	find_filter_class (filtername)
	get_filter_by_name (filtername, **options)
	get_all_filters ()
	_replace_special (ttype, value, regex, specialttype, replacefunc=lambda x:x)

Variables
dict	FILTERS

Detailed Description

    pygments.filters
    ~~~~~~~~~~~~~~~~

    Module containing filter lookup functions and default
    filters.

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

Function Documentation

find_filter_class()

pygments.filters.find_filter_class

(

filtername

)

Lookup a filter by name. Return None if not found.

get_all_filters()

pygments.filters.get_all_filters

(

)

Return a generator of all filter names.

get_filter_by_name()

pygments.filters.get_filter_by_name	(		filtername,
		**	options
	)

Return an instantiated filter.

Options are passed to the filter initializer if wanted.
Raise a ClassNotFound if not found.

Variable Documentation

FILTERS

dict pygments.filters.FILTERS

Initial value:

=  {
    'codetagify':     CodeTagFilter,
    'keywordcase':    KeywordCaseFilter,
    'highlight':      NameHighlightFilter,
    'raiseonerror':   RaiseOnErrorTokenFilter,
    'whitespace':     VisibleWhitespaceFilter,
    'gobble':         GobbleFilter,
    'tokenmerge':     TokenMergeFilter,
    'symbols':        SymbolFilter,
}