ConditionResult¶

class ConditionResult[source]¶

Contain result of a condition function.

Parameters

is_passbool: Whether the condition functions passed the given value or not.
detailsstr: What actually happened in the condition.
categoryConditionCategory , default: ConditionCategory.FAIL: The category to which the condition result belongs.

__init__(is_pass: bool, details: str = '', category: ConditionCategory = ConditionCategory.FAIL)[source]¶

__new__(*args, **kwargs)¶

Attributes

`ConditionResult.priority`	Return priority of the current condition.
`ConditionResult.is_pass`
`ConditionResult.category`
`ConditionResult.details`
`ConditionResult.name`

Methods

`ConditionResult.get_icon`()	Return icon of the result to display.
`ConditionResult.get_icon_char`()	Return icon char of the result to display.
`ConditionResult.set_name`(name)	Set name to be displayed in table.

previous

CheckFailure.to_wandb

next

ConditionResult.priority