pip._vendor.pygments.formatters.terminal256.Terminal256Formatter Class Reference

Inheritance diagram for pip._vendor.pygments.formatters.terminal256.Terminal256Formatter:

Collaboration diagram for pip._vendor.pygments.formatters.terminal256.Terminal256Formatter:

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

Public Attributes
	xterm_colors
	best_match
	style_string
	usebold
	useunderline
	useitalic
	linenos
Public Attributes inherited from pip._vendor.pygments.formatter.Formatter
	style
	full
	title
	encoding
	options

Static Public Attributes
str	name = 'Terminal256'
list	aliases = ['terminal256', 'console256', '256']
list	filenames = []
Static Public Attributes inherited from pip._vendor.pygments.formatter.Formatter
	name = None
list	aliases = []
list	filenames = []
bool	unicodeoutput = True

Protected Member Functions
	_build_color_table (self)
	_closest_color (self, r, g, b)
	_color_index (self, color)
	_setup_styles (self)
	_write_lineno (self, outfile)

Protected Attributes
	_lineno

Detailed Description

Format tokens with ANSI color sequences, for output in a 256-color
terminal or console.  Like in `TerminalFormatter` color sequences
are terminated at newlines, so that paging the output works correctly.

The formatter takes colors from a style defined by the `style` option
and converts them to nearest ANSI 256-color escape sequences. Bold and
underline attributes from the style are preserved (and displayed).

.. versionadded:: 0.9

.. versionchanged:: 2.2
   If the used style defines foreground colors in the form ``#ansi*``, then
   `Terminal256Formatter` will map these to non extended foreground color.
   See :ref:`AnsiTerminalStyle` for more information.

.. versionchanged:: 2.4
   The ANSI color names have been updated with names that are easier to
   understand and align with colornames of other projects and terminals.
   See :ref:`this table <new-ansi-color-names>` for more information.


Options accepted:

`style`
    The style to use, can be a string or a Style subclass (default:
    ``'default'``).

`linenos`
    Set to ``True`` to have line numbers on the terminal output as well
    (default: ``False`` = no line numbers).

Constructor & Destructor Documentation

__init__()

pip._vendor.pygments.formatters.terminal256.Terminal256Formatter.__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.terminal256.Terminal256Formatter.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/terminal256.py