yasmin_editor.model.validation module

Validation helpers for the YASMIN editor model.

class yasmin_editor.model.validation.ValidationMessage(path: str, message: str)

Bases: object

Represents one validation message.

message: str

path: str

class yasmin_editor.model.validation.ValidationResult(errors: list[~yasmin_editor.model.validation.ValidationMessage] = <factory>, warnings: list[~yasmin_editor.model.validation.ValidationMessage] = <factory>)

Bases: object

Collects validation errors and warnings.

add_error(path: str, message: str) → None

Add one validation error.

add_warning(path: str, message: str) → None

Add one validation warning.

errors: list[ValidationMessage]

extend(other: ValidationResult) → None

Merge another validation result into this one.

property is_valid: bool

Return whether the validated model contains no errors.

warnings: list[ValidationMessage]

yasmin_editor.model.validation.validate_model(model: State) → ValidationResult

Validate a model tree.