CheckResult

class CheckResult

Class which returns from a check with result that can later be used for automatic pipelines and display value.

Class containing the result of a check

The class stores the results and display of the check. Evaluating the result in an IPython console / notebook will show the result display output.

Parameters

valueAny

Value calculated by check. Can be used to decide if decidable check passed.

displayList[Union[Callable, str, pd.DataFrame, Styler, BaseFigure]] , default: None

Dictionary with formatters for display. possible formatters are: ‘text/html’, ‘image/png’

headerstr , default: None

Header to be displayed in python notebook.

__init__(value, header: Optional[str] = None, display: Optional[List[Union[str, DataFrame, Styler, BaseFigure, Callable[[], None], DisplayMap]]] = None)

__new__(*args, **kwargs)

Attributes

CheckResult.html_serializer	Return HtmlSerializer instance.
CheckResult.ipython_serializer	Return IPythonSerializer instance.
CheckResult.priority	Return priority of the current result.
CheckResult.run_time
CheckResult.widget_serializer	Return WidgetSerializer instance.
CheckResult.value
CheckResult.header
CheckResult.display
CheckResult.conditions_results

Methods

CheckResult.display_check([unique_id, ...])	Display the check result or return the display as widget.
CheckResult.from_json(json_dict)	Convert a json object that was returned from CheckResult.to_json or CheckFailure.to_json.
CheckResult.get_check_id([unique_id])	Return check id (used for href).
CheckResult.get_header()	Return header for display.
CheckResult.get_metadata([with_doc_link])	Return the related check metadata.
CheckResult.have_conditions()	Return if this check has condition results.
CheckResult.have_display()	Return if this check has display.
CheckResult.passed_conditions([fail_if_warning])	Return if this check has no passing condition results.
CheckResult.process_conditions()	Process the conditions results from current result and check.
CheckResult.reduce_output()	Return the check result as a reduced dict.
CheckResult.save_as_html([file, unique_id, ...])	Save a result to an HTML file.
CheckResult.show([as_widget, unique_id, ...])	Display the check result.
CheckResult.show_in_iframe([as_widget, ...])	Display result in an iframe.
CheckResult.show_in_window(**kwargs)	Display result in a separate window.
CheckResult.show_not_interactive([unique_id])	Display the not interactive version of result output.
CheckResult.to_json([with_display])	Serialize result into a json string.
CheckResult.to_wandb(**kwargs)	Send result to wandb.
CheckResult.to_widget([unique_id, ...])	Return CheckResult as a ipywidgets.Widget instance.

previous

BaseCheck.to_json

next

CheckResult.html_serializer