pip._vendor.pygments.formatters.other.RawTokenFormatter Class Reference

Inheritance diagram for pip._vendor.pygments.formatters.other.RawTokenFormatter:

Collaboration diagram for pip._vendor.pygments.formatters.other.RawTokenFormatter:

Public Member Functions
	__init__ (self, **options)
	format (self, tokensource, outfile)
Public Member Functions inherited from pip._vendor.pygments.formatter.Formatter
	get_style_defs (self, arg='')

Public Attributes
	encoding
	compress
	error_color
Public Attributes inherited from pip._vendor.pygments.formatter.Formatter
	style
	full
	title
	encoding
	options

Static Public Attributes
str	name = 'Raw tokens'
list	aliases = ['raw', 'tokens']
list	filenames = ['*.raw']
bool	unicodeoutput = False
Static Public Attributes inherited from pip._vendor.pygments.formatter.Formatter
	name = None
list	aliases = []
list	filenames = []
bool	unicodeoutput = True

Detailed Description

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
:doc:`lexer list <lexers>`.

Only two options are accepted:

`compress`
    If set to ``'gz'`` or ``'bz2'``, compress the output with the given
    compression algorithm after encoding (default: ``''``).
`error_color`
    If set to a color name, highlight error tokens using that color.  If
    set but with no value, defaults to ``'red'``.

    .. versionadded:: 0.11

Constructor & Destructor Documentation

__init__()

pip._vendor.pygments.formatters.other.RawTokenFormatter.__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 from pip._vendor.pygments.formatter.Formatter.

Member Function Documentation

format()

pip._vendor.pygments.formatters.other.RawTokenFormatter.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 from pip._vendor.pygments.formatter.Formatter.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/pygments/formatters/other.py