class documentation

class MultiReporter: (source)

View In Hierarchy

Reports messages and layouts in plain text.

Method __del__ Undocumented
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 linter.setter Undocumented
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 out.setter MultiReporter doesn't have its own output.
Method writeln Write a line in the output buffer.
Class Variable extension Undocumented
Class Variable name Undocumented
Instance Variable close_output_files Undocumented
Instance Variable messages Undocumented
Property linter Undocumented
Property out Undocumented
Property path_strip_prefix Undocumented
Instance Variable __out Undocumented
Instance Variable _linter Undocumented
Instance Variable _path_strip_prefix Undocumented
Instance Variable _sub_reporters Undocumented
def __del__(self): (source)

Undocumented

def __init__(self, sub_reporters: list[BaseReporter], close_output_files: Callable[[], None], output: TextIO|None = None): (source)

Undocumented

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

Hook for displaying the messages of the reporter.

def display_reports(self, layout: Section): (source)

Display results encapsulated in the layout tree.

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

Handle a new message triggered on the current file.

@linter.setter
def linter(self, value: PyLinter): (source)

Undocumented

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)

Hook called when a module starts to be analysed.

@out.setter
def out(self, output: TextIO|None = None): (source)

MultiReporter doesn't have its own output. This method is only provided for API parity with BaseReporter and should not be called with non-None values for 'output'.

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

Write a line in the output buffer.

extension: str = (source)

Undocumented

Undocumented

close_output_files = (source)

Undocumented

messages: list[Message] = (source)

Undocumented

@property
linter: PyLinter|None = (source)

Undocumented

Undocumented

@property
path_strip_prefix: str = (source)

Undocumented

Undocumented

Undocumented

_path_strip_prefix = (source)

Undocumented

_sub_reporters = (source)

Undocumented