Skip to content

validator

Validator for BPMN 2.0 XML documents.

CLASS DESCRIPTION
ValidationError

An error encountered during validation.

ValidationResult

Result of BPMN XML validation.

FUNCTION DESCRIPTION
validate

Validates a BPMN XML string against the BPMN 2.0 schema and additional rules.

Classes

ValidationError

ValidationError(code: str, message: str, element_id: Optional[str] = None)

Bases: Exception

An error encountered during validation.

ValidationResult

ValidationResult(errors: Optional[list[ValidationError]] = None)

Result of BPMN XML validation.

METHOD DESCRIPTION
add_errors

Adds a list of validation errors.

raise_for_errors

Raises a ValidationError if there are any errors.

Functions

add_errors
add_errors(errors: list[ValidationError]) -> None

Adds a list of validation errors.

raise_for_errors
raise_for_errors() -> None

Raises a ValidationError if there are any errors.

Functions

validate

validate(xml: str) -> ValidationResult

Validates a BPMN XML string against the BPMN 2.0 schema and additional rules.

PARAMETER DESCRIPTION
xml

The BPMN XML string to validate

TYPE: str

RETURNS DESCRIPTION
ValidationResult

ValidationResult containing validation status and any errors