entity.plugins.validation module

class entity.plugins.validation.ValidationResult(success=<bound method ValidationResult.success of <class 'entity.plugins.validation.ValidationResult'>>, errors=<factory>)[source]

Bases: object

Dataclass for returning structured validation results.

Parameters:

success (bool)
errors (List[str])

errors: List[str]

classmethod success()[source]

Create a success result.

Return type:: ValidationResult

__init__(success=<bound method ValidationResult.success of <class 'entity.plugins.validation.ValidationResult'>>, errors=<factory>)

Parameters:

success (bool)
errors (List[str])

Return type:

None

classmethod error(error)[source]

Create a failure result.

Parameters:: error (str)
Return type:: ValidationResult