pip._vendor.pygments.lexers.python.PythonConsoleLexer Class Reference

Inheritance diagram for pip._vendor.pygments.lexers.python.PythonConsoleLexer:

Collaboration diagram for pip._vendor.pygments.lexers.python.PythonConsoleLexer:

Public Member Functions
	__init__ (self, **options)
Public Member Functions inherited from pip._vendor.pygments.lexer.DelegatingLexer
	get_tokens_unprocessed (self, text)
Public Member Functions inherited from pip._vendor.pygments.lexer.Lexer
	__repr__ (self)
	add_filter (self, filter_, **options)
	analyse_text (text)
	get_tokens (self, text, unfiltered=False)
Public Member Functions inherited from pip._vendor.pygments.lexer.LexerMeta
	__new__ (mcs, name, bases, d)

Static Public Attributes
str	name = 'Python console session'
list	aliases = ['pycon']
list	mimetypes = ['text/x-python-doctest']
Static Public Attributes inherited from pip._vendor.pygments.lexer.Lexer
	name = None
list	aliases = []
list	filenames = []
list	alias_filenames = []
list	mimetypes = []
int	priority = 0
	url = None

Additional Inherited Members
Public Attributes inherited from pip._vendor.pygments.lexer.DelegatingLexer
	root_lexer
	language_lexer
	needle
Public Attributes inherited from pip._vendor.pygments.lexer.Lexer
	options
	stripnl
	stripall
	ensurenl
	tabsize
	encoding
	filters

Detailed Description

For Python console output or doctests, such as:

.. sourcecode:: pycon

    >>> a = 'foo'
    >>> print(a)
    foo
    >>> 1 / 0
    Traceback (most recent call last):
      File "<stdin>", line 1, in <module>
    ZeroDivisionError: integer division or modulo by zero

Additional options:

`python3`
    Use Python 3 lexer for code.  Default is ``True``.

    .. versionadded:: 1.0
    .. versionchanged:: 2.5
       Now defaults to ``True``.

Constructor & Destructor Documentation

__init__()

pip._vendor.pygments.lexers.python.PythonConsoleLexer.__init__	(		self,
		**	options
	)

This constructor takes arbitrary options as keyword arguments.
Every subclass must first process its own options and then call
the `Lexer` constructor, since it processes the basic
options like `stripnl`.

An example looks like this:

.. sourcecode:: python

   def __init__(self, **options):
       self.compress = options.get('compress', '')
       Lexer.__init__(self, **options)

As these options must all be specifiable as strings (due to the
command line usage), there are various utility functions
available to help with that, see `Utilities`_.

Reimplemented from pip._vendor.pygments.lexer.DelegatingLexer.

---

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

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