1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
import os
from typing import IO, Any, AnyStr, Callable, List, Optional
from pylint.interfaces import IReporter
from pylint.message import Message
from pylint.reporters.base_reporter import BaseReporter
from pylint.reporters.ureports.nodes import BaseLayout
from pylint.typing import CheckerStats
AnyFile = IO[AnyStr]
PyLinter = Any
class MultiReporter:
"""Reports messages and layouts in plain text"""
__implements__ = IReporter
name = "_internal_multi_reporter"
# Note: do not register this reporter with linter.register_reporter as it is
# not intended to be used directly like a regular reporter, but is
# instead used to implement the
# `--output-format=json:somefile.json,colorized`
# multiple output formats feature
extension = ""
def __init__(
self,
sub_reporters: List[BaseReporter],
close_output_files: Callable[[], None],
output: Optional[AnyFile] = None,
):
self._sub_reporters = sub_reporters
self.close_output_files = close_output_files
self._path_strip_prefix = os.getcwd() + os.sep
self._linter: Optional[PyLinter] = None
self.set_output(output)
def __del__(self) -> None:
self.close_output_files()
@property
def path_strip_prefix(self) -> str:
return self._path_strip_prefix
@property
def linter(self) -> Optional[PyLinter]:
return self._linter
@linter.setter
def linter(self, value: PyLinter) -> None:
self._linter = value
for rep in self._sub_reporters:
rep.linter = value
def handle_message(self, msg: Message) -> None:
"""Handle a new message triggered on the current file."""
for rep in self._sub_reporters:
rep.handle_message(msg)
# pylint: disable=no-self-use
def set_output(self, output: Optional[AnyFile] = None) -> None:
"""set output stream"""
# MultiReporter doesn't have it's own output. This method is only
# provided for API parity with BaseReporter and should not be called
# with non-None values for 'output'.
if output is not None:
raise NotImplementedError("MultiReporter does not support direct output.")
def writeln(self, string: str = "") -> None:
"""write a line in the output buffer"""
for rep in self._sub_reporters:
rep.writeln(string)
def display_reports(self, layout: BaseLayout) -> None:
"""display results encapsulated in the layout tree"""
for rep in self._sub_reporters:
rep.display_reports(layout)
def display_messages(self, layout: BaseLayout) -> None:
"""hook for displaying the messages of the reporter"""
for rep in self._sub_reporters:
rep.display_messages(layout)
def on_set_current_module(self, module: str, filepath: Optional[str]) -> None:
"""hook called when a module starts to be analysed"""
for rep in self._sub_reporters:
rep.on_set_current_module(module, filepath)
def on_close(
self,
stats: CheckerStats,
previous_stats: CheckerStats,
) -> None:
"""hook called when a module finished analyzing"""
for rep in self._sub_reporters:
rep.on_close(stats, previous_stats)
|
