jade.result.ResultsSummary

class jade.result.ResultsSummary(output_dir)

Bases: object

Provides summary of all job results.

Methods

get_canceled_results()	Return the canceled results.
get_failed_results()	Return the failed results.
get_missing_jobs(expected_jobs)	Return the jobs for which there are no results.
get_result(job_name)	Return the job result from the results :param job_name: :type job_name: str
get_results_by_type()	Return the results split by type.
get_successful_result(job_name)	Return the successful job result from the results :param job_name: :type job_name: str
get_successful_results()	Return the successful results.
list_results()	Return the results.
show_results([only_failed, only_successful])	Show the results in a table.

Attributes

base_directory	Return the base directory for the job results.
missing_jobs
results	Return the results.

property base_directory

Return the base directory for the job results.

Return type:

str

property results

Return the results.

Returns:

iterable of Result objects

Return type:

dict_values

get_result(job_name)

Return the job result from the results :param job_name: :type job_name: str

Return type:

dict

get_successful_result(job_name)

Return the successful job result from the results :param job_name: :type job_name: str

Return type:

dict

Raises:

• InvalidParameter – Raised if job_name is not found.

• ExecutionError – Raised if the result was not successful.

get_results_by_type()

Return the results split by type.

Return type:

dict

get_successful_results()

Return the successful results.

get_missing_jobs(expected_jobs)

Return the jobs for which there are no results.

Parameters:

• expected_jobs (list)

• results (jobs that are expected to be in)

Return type:

list

get_canceled_results()

Return the canceled results.

get_failed_results()

Return the failed results.

list_results()

Return the results.

Return type:

list

show_results(only_failed=False, only_successful=False)

Show the results in a table.