mirror of
https://fuchsia.googlesource.com/third_party/github.com/pylint-dev/pylint
synced 2024-09-21 07:58:04 +00:00
112 lines
3.2 KiB
Python
112 lines
3.2 KiB
Python
# 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
|
|
|
|
"""Interfaces for Pylint objects."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from collections import namedtuple
|
|
from typing import TYPE_CHECKING
|
|
|
|
from astroid import nodes
|
|
|
|
if TYPE_CHECKING:
|
|
from pylint.checkers import BaseChecker
|
|
from pylint.reporters.ureports.nodes import Section
|
|
|
|
__all__ = (
|
|
"IRawChecker",
|
|
"IAstroidChecker",
|
|
"ITokenChecker",
|
|
"IReporter",
|
|
"IChecker",
|
|
"HIGH",
|
|
"CONTROL_FLOW",
|
|
"INFERENCE",
|
|
"INFERENCE_FAILURE",
|
|
"UNDEFINED",
|
|
"CONFIDENCE_LEVELS",
|
|
"CONFIDENCE_LEVEL_NAMES",
|
|
)
|
|
|
|
Confidence = namedtuple("Confidence", ["name", "description"])
|
|
# Warning Certainties
|
|
HIGH = Confidence("HIGH", "Warning that is not based on inference result.")
|
|
CONTROL_FLOW = Confidence(
|
|
"CONTROL_FLOW", "Warning based on assumptions about control flow."
|
|
)
|
|
INFERENCE = Confidence("INFERENCE", "Warning based on inference result.")
|
|
INFERENCE_FAILURE = Confidence(
|
|
"INFERENCE_FAILURE", "Warning based on inference with failures."
|
|
)
|
|
UNDEFINED = Confidence("UNDEFINED", "Warning without any associated confidence level.")
|
|
|
|
CONFIDENCE_LEVELS = [HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, UNDEFINED]
|
|
CONFIDENCE_LEVEL_NAMES = [i.name for i in CONFIDENCE_LEVELS]
|
|
|
|
|
|
class Interface:
|
|
"""Base class for interfaces."""
|
|
|
|
@classmethod
|
|
def is_implemented_by(cls, instance):
|
|
return implements(instance, cls)
|
|
|
|
|
|
def implements(
|
|
obj: BaseChecker,
|
|
interface: type[Interface] | tuple[type[Interface], ...],
|
|
) -> bool:
|
|
"""Does the given object (maybe an instance or class) implement the interface."""
|
|
implements_ = getattr(obj, "__implements__", ())
|
|
if not isinstance(implements_, (list, tuple)):
|
|
implements_ = (implements_,)
|
|
return any(issubclass(i, interface) for i in implements_)
|
|
|
|
|
|
class IChecker(Interface):
|
|
"""Base interface, to be used only for sub interfaces definition."""
|
|
|
|
def open(self):
|
|
"""Called before visiting project (i.e. set of modules)."""
|
|
|
|
def close(self):
|
|
"""Called after visiting project (i.e. set of modules)."""
|
|
|
|
|
|
class IRawChecker(IChecker):
|
|
"""Interface for checker which need to parse the raw file."""
|
|
|
|
def process_module(self, node: nodes.Module) -> None:
|
|
"""Process a module.
|
|
|
|
The module's content is accessible via ``astroid.stream``
|
|
"""
|
|
|
|
|
|
class ITokenChecker(IChecker):
|
|
"""Interface for checkers that need access to the token list."""
|
|
|
|
def process_tokens(self, tokens):
|
|
"""Process a module.
|
|
|
|
Tokens is a list of all source code tokens in the file.
|
|
"""
|
|
|
|
|
|
class IAstroidChecker(IChecker):
|
|
"""Interface for checker which prefers receive events according to
|
|
statement type
|
|
"""
|
|
|
|
|
|
class IReporter(Interface):
|
|
"""Reporter collect messages and display results encapsulated in a layout."""
|
|
|
|
def handle_message(self, msg) -> None:
|
|
"""Handle the given message object."""
|
|
|
|
def display_reports(self, layout: Section) -> None:
|
|
"""Display results encapsulated in the layout tree."""
|