pip._vendor.pygments.formatters.irc.IRCFormatter Class Reference

Inheritance diagram for pip._vendor.pygments.formatters.irc.IRCFormatter:

Collaboration diagram for pip._vendor.pygments.formatters.irc.IRCFormatter:

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

Public Attributes
	darkbg
	colorscheme
	linenos
Public Attributes inherited from pip._vendor.pygments.formatter.Formatter
	style
	full
	title
	encoding
	options

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

Protected Member Functions
	_write_lineno (self, outfile)

Protected Attributes
	_lineno

Detailed Description

Format tokens with IRC color sequences

The `get_style_defs()` method doesn't do anything special since there is
no support for common styles.

Options accepted:

`bg`
    Set to ``"light"`` or ``"dark"`` depending on the terminal's background
    (default: ``"light"``).

`colorscheme`
    A dictionary mapping token types to (lightbg, darkbg) color names or
    ``None`` (default: ``None`` = use builtin colorscheme).

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

Constructor & Destructor Documentation

__init__()

pip._vendor.pygments.formatters.irc.IRCFormatter.__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.

---

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

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