pip_services3_commons.validate.ValidationException module

pip_services_common.validate.ValidationException

Validation error type

copyright

Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.

license

MIT, see LICENSE for more details.

exception pip_services3_commons.validate.ValidationException.ValidationException(correlation_id: Optional[str, None], message: Optional[str, None], results: List[pip_services3_commons.validate.ValidationResult.ValidationResult])

Bases: pip_services3_commons.errors.BadRequestException.BadRequestException

Errors in schema validation.

Validation errors are usually generated based in ValidationResult. If using strict mode, warnings will also raise validation exceptions.

static compose_message(results: List[pip_services3_commons.validate.ValidationResult.ValidationResult]) → str

Composes human readable error message based on validation results.

Parameters

results – a list of validation results.

Returns

a composed error message.

static from_results(correlation_id: Optional[str, None], results: List[pip_services3_commons.validate.ValidationResult.ValidationResult], strict: bool) → pip_services3_commons.validate.ValidationException.ValidationException

Creates a new ValidationException based on errors in validation results. If validation results have no errors, than null is returned.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • results – list of validation results that may contain errors

  • strict – true to treat warnings as errors.

Returns

a newly created ValidationException or null if no errors in found.

static throw_exception_if_needed(correlation_id: Optional[str, None], results: List[pip_services3_commons.validate.ValidationResult.ValidationResult], strict: bool)

Throws ValidationException based on errors in validation results. If validation results have no errors, than no error is thrown.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • results – list of validation results that may contain errors

  • strict – true to treat warnings as errors.