?HAMA

Navigation

Breadcrumbs

Create

Edit File Size: 1.54 KB

/proc/thread-self/root/opt/cloudlinux/venv/lib64/python3.11/site-packages/prospector/tools/base.py

Text Base64

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

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
bandit DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
dodgy DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
mccabe DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
mypy DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
profile_validator DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
pycodestyle DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
pydocstyle DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
pyflakes DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
pylint DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
pyright DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
pyroma DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
vulture DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
__pycache__ DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
base.py	1.54 KB	lrw-r--r--	2026-01-20 13:01:48	Edit Download recursive recursive
exceptions.py	170 B	lrw-r--r--	2026-01-20 13:01:48	Edit Download recursive recursive
utils.py	1.13 KB	lrw-r--r--	2026-01-20 13:01:48	Edit Download recursive recursive
__init__.py	2.59 KB	lrw-r--r--	2026-01-20 13:01:48	Edit Download recursive recursive

Directory Contents