project_config.reporters package

Error reporters.

exception project_config.reporters.InvalidNotBasedThirdPartyReporter(message: str)[source]

Reporter not based on base reporter class.

All reporters must be based on the base reporter class :py::class:project_config.reporters.base.BaseReporter.

exception project_config.reporters.InvalidThirdPartyReportersModule(message: str)[source]

Third party reporters module is invalid.

Third party reporters module must expose a color and a black/white reporter.

class project_config.reporters.ThirdPartyReporters[source]

Third party reporters loader from entrypoints.

property ids: List[str]: Returns the identifiers of the 3rd party reporters.

instance: Optional[project_config.reporters.ThirdPartyReporters] = <project_config.reporters.ThirdPartyReporters object>

load(reporter_name: str) → module[source]

Load a third party reporter.

validate_reporter_class(reporter_class: Any) → None[source]

Validate a reporter class.

validate_reporter_module(reporter_module: module) → Tuple[str, str][source]

Validate a reporter module.

Returns black/white and color reporter class names if the reporters module is valid.

project_config.reporters._parse_reporter_arguments(arguments_string: str) → Dict[str, Any][source]

project_config.reporters.get_reporter(reporter_name: str, reporter_kwargs: Dict[str, Any], color: Optional[bool], rootdir: str) → Any[source]

Reporters factory.

Parameters

reporter_name (str) – Reporter identifier name.
reporter_kwargs (dict) – Optional arguments for reporter class.
color (bool) – Return the colorized version of the reporter, if is implemented, using the black/white version as a fallback.
rootdir (str) – Root directory of the project.

project_config.reporters.parse_reporter_id(value: str) → Tuple[str, Dict[str, Any]][source]

Parse a reporter identifier.

Returns the reporter name and the optional arguments for his class.

Submodules