SuiteResult#

class SuiteResult[source]#

Contain the results of a suite run.

Parameters
name: str
results: List[BaseCheckResult]
extra_info: Optional[List[str]]
__init__(name: str, results: List[BaseCheckResult], extra_info: Optional[List[str]] = None)[source]#

Initialize suite result.

__new__(*args, **kwargs)#

Attributes

SuiteResult.html_serializer

Return HtmlSerializer instance.

SuiteResult.ipython_serializer

Return IPythonSerializer instance.

SuiteResult.widget_serializer

Return WidgetSerializer instance.

SuiteResult.name

SuiteResult.extra_info

SuiteResult.results

Methods

SuiteResult.from_json(json_res)

Convert a json object that was returned from SuiteResult.to_json.

SuiteResult.get_not_passed_checks([...])

Get all the check results that have not passing condition.

SuiteResult.get_not_ran_checks()

Get all the check results which did not run (unable to run due to missing parameters, exception, etc).

SuiteResult.get_passed_checks([fail_if_warning])

Get all the check results that have passing condition.

SuiteResult.passed([fail_if_warning, ...])

Return whether this suite result has passed.

SuiteResult.save_as_cml_markdown([file, ...])

Save a result to a markdown file to use with [CML](https://cml.dev).

SuiteResult.save_as_html([file, as_widget, ...])

Save output as html file.

SuiteResult.select_results([idx, names])

Select results either by indexes or result header names.

SuiteResult.show([as_widget, unique_id])

Display result.

SuiteResult.show_in_iframe([as_widget, ...])

Display result in an iframe.

SuiteResult.show_in_window(**kwargs)

Display result in a separate window.

SuiteResult.show_not_interactive([unique_id])

Display the not interactive version of result output.

SuiteResult.to_json([with_display])

Return check result as json.

SuiteResult.to_wandb([dedicated_run])

Send suite result to wandb.

SuiteResult.to_widget([unique_id])

Return SuiteResult as a ipywidgets.Widget instance.