validate_actions.cli_components.result_aggregator

Aggregates validation results for CLI output. Especially for multiple files.

Classes

MaxWarningsResultAggregator(cli_config)

Result aggregator that enforces a maximum number of warnings.

ResultAggregator(cli_config)

Abstract base class for aggregating validation results across multiple files.

StandardResultAggregator(cli_config)

Standard implementation with exit code 0 for any warnings and 1 for errors.
class validate_actions.cli_components.result_aggregator.ResultAggregator(cli_config)[source]

Bases: ABC

Abstract base class for aggregating validation results across multiple files.

Parameters:

cli_config (CLIConfig)

get_total_errors()[source]

Get total errors across all files.

Return type:

int

get_total_warnings()[source]

Get total warnings across all files.

Return type:

int

get_max_level()[source]

Get highest problem level encountered.

Return type:

ProblemLevel

get_results()[source]

Get all validation results.

Return type:

List[ValidationResult]

abstractmethod add_result(result)[source]

Add a validation result and update aggregated stats.

Parameters:

result (ValidationResult)

Return type:

None

abstractmethod get_exit_code()[source]

Get appropriate exit code based on results.

Return type:

int

class validate_actions.cli_components.result_aggregator.StandardResultAggregator(cli_config)[source]

Bases: ResultAggregator

Standard implementation with exit code 0 for any warnings and 1 for errors.

Parameters:

cli_config (CLIConfig)

add_result(result)[source]

Add a validation result and update aggregated stats.

Parameters:

result (ValidationResult)

Return type:

None

get_exit_code()[source]

Get exit code based on problem levels.

Return type:

int

class validate_actions.cli_components.result_aggregator.MaxWarningsResultAggregator(cli_config)[source]

Bases: ResultAggregator

Result aggregator that enforces a maximum number of warnings.

Parameters:

cli_config (CLIConfig)

add_result(result)[source]

Add a validation result and update aggregated stats.

Parameters:

result (ValidationResult)

Return type:

None

get_exit_code()[source]

Get exit code based on problem levels and max warnings limit.

Return type:

int