Current File : //opt/cloudlinux/venv/lib64/python3.11/site-packages/prospector/tools/base.py
from abc import ABC, abstractmethod
from typing import Iterable, List, Optional, Tuple
from prospector.message import Message
class ToolBase(ABC):
@abstractmethod
def configure(self, prospector_config, found_files) -> Tuple[str, Optional[Iterable[Message]]]:
"""
Tools have their own way of being configured from configuration files
on the current path - for example, a .pep8rc file. Prospector will use
its own configuration settings unless this method discovers some
tool-specific configuration that should be used instead.
:return: A tuple: the first element is a string indicating how or where
this tool was configured from. For example, this can be a path
to the .pylintrc file used, if used. None means that prospector
defaults were used. The second element should be an iterable of
Message objects representing any issues which were found when
trying to load configuration - for example, bad values in a
.pylintrc file. It is also possible to simply return None if
neither value is useful.
"""
raise NotImplementedError
@abstractmethod
def run(self, found_files) -> List[Message]:
"""
Actually run the tool and collect the various messages emitted by the tool.
It is expected that this will convert whatever output of the tool into the
standard prospector Message and Location objects.
"""
raise NotImplementedError