pylint.reporters.BaseReporter

class documentation

class BaseReporter: (source)

Known subclasses: pylint.reporters.CollectingReporter, pylint.reporters.text.TextReporter, pylint.testutils.GenericTestReporter, pylint.testutils.MinimalTestReporter, pylint.testutils.reporter_for_tests.FunctionalTestReporter

View In Hierarchy

Base class for reporters. symbols: show short symbolic names for messages.

Method __init__ Undocumented
Method display_messages Hook for displaying the messages of the reporter.
Method display_reports Display results encapsulated in the layout tree.
Method handle_message Handle a new message triggered on the current file.
Method on_close Hook called when a module finished analyzing.
Method on_set_current_module Hook called when a module starts to be analysed.
Method set_output Set output stream.
Method writeln Write a line in the output buffer.
Class Variable extension Undocumented
Class Variable name Name of the reporter.
Instance Variable linter Undocumented
Instance Variable messages Undocumented
Instance Variable out Undocumented
Instance Variable path_strip_prefix Undocumented
Instance Variable section Undocumented
Method _display Display the layout.
def __init__(self, output: TextIO|None = None): (source)
overridden in pylint.reporters.CollectingReporter, pylint.reporters.text.TextReporter, pylint.testutils.GenericTestReporter

Undocumented

def display_messages(self, layout: Section|None): (source)

Hook for displaying the messages of the reporter. This will be called whenever the underlying messages needs to be displayed. For some reporters, it probably doesn't make sense to display messages as soon as they are available, so some mechanism of storing them could be used. This method can be implemented to display them after they've been aggregated.

def display_reports(self, layout: Section): (source)
overridden in pylint.testutils.GenericTestReporter, pylint.testutils.reporter_for_tests.FunctionalTestReporter

Display results encapsulated in the layout tree.

def handle_message(self, msg: Message): (source)
overridden in pylint.reporters.text.TextReporter, pylint.testutils.GenericTestReporter

Handle a new message triggered on the current file.

def on_close(self, stats: LinterStats, previous_stats: LinterStats|None): (source)

Hook called when a module finished analyzing.

def on_set_current_module(self, module: str, filepath: str|None): (source)
overridden in pylint.reporters.text.TextReporter, pylint.testutils.GenericTestReporter, pylint.testutils.MinimalTestReporter

Hook called when a module starts to be analysed.

def set_output(self, output: TextIO|None = None): (source)

Set output stream.

def writeln(self, string: str = ''): (source)

Write a line in the output buffer.

extension: str = (source)
overridden in pylint.reporters.text.TextReporter

Undocumented

name: str = (source)
overridden in pylint.reporters.CollectingReporter, pylint.reporters.text.TextReporter

Name of the reporter.

linter: PyLinter = (source)

Undocumented

messages: list[Message] = (source)
overridden in pylint.reporters.CollectingReporter, pylint.testutils.GenericTestReporter, pylint.testutils.MinimalTestReporter

Undocumented

out = (source)
overridden in pylint.reporters.text.ColorizedTextReporter, pylint.testutils.GenericTestReporter

Undocumented

path_strip_prefix = (source)
overridden in pylint.testutils.GenericTestReporter

Undocumented

section: int = (source)

Undocumented

def _display(self, layout: Section): (source)
overridden in pylint.reporters.CollectingReporter, pylint.reporters.text.TextReporter, pylint.testutils.GenericTestReporter, pylint.testutils.MinimalTestReporter, pylint.testutils.reporter_for_tests.FunctionalTestReporter

Display the layout.