CheckFailure#

class CheckFailure[source]#

Class which holds a check run exception.

Parameters
checkBaseCheck
exceptionException
header_suffixstr , default ``
__init__(check: BaseCheck, exception: Exception, header_suffix: str = '')[source]#
__new__(*args, **kwargs)#

Attributes

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()

Display the check failure.

CheckFailure.to_json([with_display])

Return check failure as json.

CheckFailure.to_wandb([dedicated_run])

Export check result to wandb.

CheckFailure.to_widget()

Return CheckFailure as a ipywidgets.Widget instance.