pylint.reporters.text.TextReporter

class documentation

class TextReporter(BaseReporter): (source)

Known subclasses: pylint.reporters.text.ColorizedTextReporter, pylint.reporters.text.NoHeaderReporter, pylint.reporters.text.ParseableTextReporter

View In Hierarchy

Reports messages and layouts in plain text.

Method __init__ Undocumented
Method handle_message Manage message of different type and in the context of path.
Method on_set_current_module Set the format template to be used and check for unrecognized arguments.
Method write_message Convenience method to write a formatted message with class default template.
Class Variable extension Undocumented
Class Variable line_format Undocumented
Class Variable name Name of the reporter.
Method _display Launch layouts display.
Instance Variable _fixed_template The output format template with any unrecognized arguments removed.
Instance Variable _modules Undocumented
Instance Variable _template Undocumented

Inherited from BaseReporter:

Method display_messages Hook for displaying the messages of the reporter.
Method display_reports Display results encapsulated in the layout tree.
Method on_close Hook called when a module finished analyzing.
Method set_output Set output stream.
Method writeln Write a line in the output buffer.
Instance Variable linter Undocumented
Instance Variable messages Undocumented
Instance Variable out Undocumented
Instance Variable path_strip_prefix Undocumented
Instance Variable section Undocumented
def __init__(self, output: TextIO|None = None): (source)
overrides pylint.reporters.BaseReporter.__init__
overridden in pylint.reporters.text.ColorizedTextReporter, pylint.reporters.text.ParseableTextReporter

Undocumented

def handle_message(self, msg: Message): (source)
overrides pylint.reporters.BaseReporter.handle_message
overridden in pylint.reporters.text.ColorizedTextReporter, pylint.reporters.text.NoHeaderReporter

Manage message of different type and in the context of path.

def on_set_current_module(self, module: str, filepath: str|None): (source)
overrides pylint.reporters.BaseReporter.on_set_current_module

Set the format template to be used and check for unrecognized arguments.

def write_message(self, msg: Message): (source)

Convenience method to write a formatted message with class default template.

extension: str = (source)
overrides pylint.reporters.BaseReporter.extension

Undocumented

line_format: str = (source)
overridden in pylint.reporters.text.ParseableTextReporter

Undocumented

name: str = (source)
overrides pylint.reporters.BaseReporter.name
overridden in pylint.reporters.text.ColorizedTextReporter, pylint.reporters.text.NoHeaderReporter, pylint.reporters.text.ParseableTextReporter

Name of the reporter.

def _display(self, layout: Section): (source)
overrides pylint.reporters.BaseReporter._display

Launch layouts display.

_fixed_template = (source)

The output format template with any unrecognized arguments removed.

_modules: set[str] = (source)

Undocumented

_template = (source)

Undocumented