pylint.reporters.text

module documentation
(source)

Plain text reporters:. :text: the default one grouping messages by module :colorized: an ANSI colorized text reporter

Class ColorizedTextReporter Simple TextReporter that colorizes text output.
Class MessageStyle Styling of a message.
Class NoHeaderReporter Reports messages and layouts in plain text without a module header.
Class ParseableTextReporter A reporter very similar to TextReporter, but display messages in a form recognized by most text editors :
Class TextReporter Reports messages and layouts in plain text.
Class VSTextReporter Visual studio text reporter.
Function colorize_ansi colorize message by wrapping it with ANSI escape codes
Function make_header Undocumented
Function register Undocumented
Constant ANSI_COLORS Undocumented
Constant ANSI_END Undocumented
Constant ANSI_PREFIX Undocumented
Constant ANSI_RESET Undocumented
Constant ANSI_STYLES Undocumented
Constant MESSAGE_FIELDS All fields of the Message class.
Constant TITLE_UNDERLINES Undocumented
Type Alias ColorMappingDict Undocumented
Function _get_ansi_code Return ANSI escape code corresponding to color and style.
@overload
def colorize_ansi(msg: str, msg_style: MessageStyle|None = ...) -> str:
@overload
def colorize_ansi(msg: str, msg_style: str|None = ..., style: str = ..., *, color: str|None = ...) -> str:
(source)

colorize message by wrapping it with ANSI escape codes :param msg: the message string to colorize :param msg_style: the message style or color (for backwards compatibility): the color of the message style :param style: the message's style elements, this will be deprecated :param \**kwargs: used to accept `color` parameter while it is being deprecated :return: the ANSI escaped string

def make_header(msg: Message) -> str: (source)

Undocumented

def register(linter: PyLinter): (source)

Undocumented

ANSI_COLORS: dict[str, str] = (source)

Undocumented

Value
{'reset': '0',
 'black': '30',
 'red': '31',
 'green': '32',
 'yellow': '33',
 'blue': '34',
 'magenta': '35',
...
ANSI_END: str = (source)

Undocumented

Value
'm'
ANSI_PREFIX: str = (source)

Undocumented

Value
'\x1b['
ANSI_RESET: str = (source)

Undocumented

Value
'\x1b[0m'
ANSI_STYLES: dict[str, str] = (source)

Undocumented

Value
{'reset': '0',
 'bold': '1',
 'italic': '3',
 'underline': '4',
 'blink': '5',
 'inverse': '7',
 'strike': '9'}
MESSAGE_FIELDS = (source)

All fields of the Message class.

Value
{i.name for i in fields(Message)}
TITLE_UNDERLINES: list[str] = (source)

Undocumented

Value
['', '=', '-', '.']
ColorMappingDict = (source)

Undocumented

Value
Dict[str, MessageStyle]
def _get_ansi_code(msg_style: MessageStyle) -> str: (source)

Return ANSI escape code corresponding to color and style. :param msg_style: the message style :raise KeyError: if a nonexistent color or style identifier is given :return: the built escape code