cursus.validation.script_testing.result_formatter

Result Formatter

Comprehensive result formatting utilities for script testing results. Provides various output formats and visualization options for script execution results.

This is a well-designed component with 15% redundancy (Good Efficiency) that we preserve as-is from the original implementation.

class ResultFormatter(format_options=None)[source]

Bases: object

Comprehensive result formatting utilities for script testing results.

Provides multiple output formats and visualization options for script execution results, including console output, JSON, CSV, and HTML reports.

Key features: 1. Multiple output formats (console, JSON, CSV, HTML) 2. Customizable formatting options 3. Summary and detailed reporting 4. Error highlighting and analysis 5. Performance metrics visualization

format_options

Dictionary of formatting configuration options

format_execution_results(results, format_type='console')[source]

Format complete execution results in specified format.

Parameters:

  • results (Dict[str, Any]) – Dictionary with execution results from script testing

  • format_type (str) – Output format (“console”, “json”, “csv”, “html”)

Returns:

Formatted results string

Return type:

str

format_script_result(script_result, format_type='console')[source]

Format individual script result.

Parameters:

  • script_result (ScriptTestResult) – ScriptTestResult to format

  • format_type (str) – Output format (“console”, “json”, “summary”)

Returns:

Formatted script result string

Return type:

str

create_summary_report(results)[source]

Create a comprehensive summary report.

Parameters:

results (Dict[str, Any]) – Dictionary with execution results

Returns:

Formatted summary report

Return type:

str

save_results_to_file(results, output_path, format_type='json')[source]

Save results to file in specified format.

Parameters:

  • results (Dict[str, Any]) – Dictionary with execution results

  • output_path (str) – Path to save results

  • format_type (str) – Output format (“json”, “csv”, “html”, “txt”)

Returns:

Path to saved file

Return type:

Path

get_formatter_summary()[source]

Get a summary of the formatter configuration and capabilities.

Returns:

Dictionary with formatter summary information

Return type:

Dict[str, Any]