Checkers package

class rebasehelper.plugins.checkers.BaseChecker

Base class of package checkers.

DEFAULT

If True, the checker is run by default.

Type:bool

CATEGORY

Category which determines when the checker is run.

Type:CheckerCategory

results_dir

Path where the results are stored.

Type:str

CATEGORY = None

DEFAULT = False

classmethod format(data)

Formats checker output to a readable text form.

classmethod get_category()

classmethod get_checker_output_dir_short()

Return short version of checker output directory

classmethod get_important_changes(checker_output)

Each checker has an opportunity to highlight some of its output. This function is optional, as not all checkers provide output with critical information.

Parameters:checker_output (dict) – Dictionary with output from the given checker. Returns:List of strings to be output to CLI as warning messages. Return type:list

classmethod get_underlined_title(text, separator='=')

classmethod is_available()

classmethod prepare_results_dir()

Creates checker’s results dir.

Removes the existing results dir if it exists to avoid collisions.

results_dir = None

classmethod run_check(results_dir, **kwargs)

Perform the check itself and return results.

class rebasehelper.plugins.checkers.CheckerCategory

An enumeration.

RPM = 3

SOURCE = 1

SRPM = 2

class rebasehelper.plugins.checkers.CheckerCollection(entrypoint: str, manager: PluginManager)

Class representing the process of running various checkers on final packages.

get_default_plugins(return_one: bool = False) → Union[str, List[str], None]

get_supported_plugins() → List[str]

run(results_dir: str, checker_name: str, **kwargs) → Optional[Dict[str, Any]]

Runs a particular checker and returns the results.

Parameters:

• results_dir – Path to a directory in which the checker should store the results.
• checker_name – Name of the checker to be run.

Raises:

NotImplementedError – If a checker with the given name doesn’t exist.

Returns:

Results of the checker.