ValidationResult#

class scikitplot.corpus.ValidationResult(valid, errors=<factory>)[source]#

Aggregate result of a validation pass.

Parameters:

validbool

True if no errors were found.

errorslist[ValidationError]

All validation errors. Empty when valid is True.

Parameters:

• valid (bool)

• errors (list[ValidationError])

Examples

Try it in your browser!

>>> result = ValidationResult(valid=True, errors=[])
>>> result.valid
True

Go BackOpen In Tab

errors: list[ValidationError][source]#

raise_if_invalid(context='')[source]#

Raise a ValueError if this result is invalid.

Parameters:

contextstr, optional

Extra context prepended to the error message.

Raises:

ValueError

If valid is False, with all error messages joined.

Parameters:

context (str)

Return type:

None

valid: bool[source]#