CheckFailure

class CheckFailure

Class which holds a check run exception.

Parameters

checkBaseCheck

exceptionException

header_suffixstr , default ``

__init__(check: BaseCheck, exception: Exception, header_suffix: str = '')

__new__(*args, **kwargs)

Attributes

CheckFailure.html_serializer	Return HtmlSerializer instance.
CheckFailure.ipython_serializer	Return IPythonSerializer instance.
CheckFailure.run_time
CheckFailure.widget_serializer	Return WidgetSerializer instance.

Methods

CheckFailure.display_check([as_widget])	Display the check failure or return the display as widget.
CheckFailure.from_json(json_dict)	Convert a json object that was returned from CheckResult.to_json or CheckFailure.to_json.
CheckFailure.get_check_id([unique_id])	Return check id (used for href).
CheckFailure.get_header()	Return header for display.
CheckFailure.get_metadata([with_doc_link])	Return the related check metadata.
CheckFailure.print_traceback()	Print the traceback of the failure.
CheckFailure.save_as_html([file, as_widget, ...])	Save output as html file.
CheckFailure.show([as_widget, unique_id])	Display result.
CheckFailure.show_in_iframe([as_widget, ...])	Display result in an iframe.
CheckFailure.show_in_window(**kwargs)	Display result in a separate window.
CheckFailure.show_not_interactive([unique_id])	Display the not interactive version of result output.
CheckFailure.to_json(**kwargs)	Serialize CheckFailure into a json string.
CheckFailure.to_wandb(**kwargs)	Send check result to wandb.
CheckFailure.to_widget(**kwargs)	Return CheckFailure as a ipywidgets.Widget instance.

previous

CheckResult.to_widget

next

CheckFailure.html_serializer