Viewing file:  reports_handler_mix_in.py (3 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
# 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
# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
from __future__ import annotations
import collections
from collections.abc import MutableSequence
from typing import TYPE_CHECKING, DefaultDict, List, Tuple
from pylint.exceptions import EmptyReportError
from pylint.reporters.ureports.nodes import Section
from pylint.typing import ReportsCallable
from pylint.utils import LinterStats
if TYPE_CHECKING:
from pylint.checkers import BaseChecker
from pylint.lint.pylinter import PyLinter
ReportsDict = DefaultDict["BaseChecker", List[Tuple[str, str, ReportsCallable]]]
class ReportsHandlerMixIn:
"""A mix-in class containing all the reports and stats manipulation
related methods for the main lint class.
"""
def __init__(self) -> None:
self._reports: ReportsDict = collections.defaultdict(list)
self._reports_state: dict[str, bool] = {}
def report_order(self) -> MutableSequence[BaseChecker]:
"""Return a list of reporters."""
return list(self._reports)
def register_report(
self, reportid: str, r_title: str, r_cb: ReportsCallable, checker: BaseChecker
) -> None:
"""Register a report.
:param reportid: The unique identifier for the report
:param r_title: The report's title
:param r_cb: The method to call to make the report
:param checker: The checker defining the report
"""
reportid = reportid.upper()
self._reports[checker].append((reportid, r_title, r_cb))
def enable_report(self, reportid: str) -> None:
"""Enable the report of the given id."""
reportid = reportid.upper()
self._reports_state[reportid] = True
def disable_report(self, reportid: str) -> None:
"""Disable the report of the given id."""
reportid = reportid.upper()
self._reports_state[reportid] = False
def report_is_enabled(self, reportid: str) -> bool:
"""Is the report associated to the given identifier enabled ?"""
return self._reports_state.get(reportid, True)
def make_reports( # type: ignore[misc] # ReportsHandlerMixIn is always mixed with PyLinter
self: PyLinter,
stats: LinterStats,
old_stats: LinterStats | None,
) -> Section:
"""Render registered reports."""
sect = Section("Report", f"{self.stats.statement} statements analysed.")
for checker in self.report_order():
for reportid, r_title, r_cb in self._reports[checker]:
if not self.report_is_enabled(reportid):
continue
report_sect = Section(r_title)
try:
r_cb(report_sect, stats, old_stats)
except EmptyReportError:
continue
report_sect.report_id = reportid
sect.append(report_sect)
return sect
|