ValidationErrorType Enum

  • Reference

Error types to be specified when using ValidationException class. Types are then used in raise_error.py to format a detailed error message for users.

When using ValidationException, specify the type that best describes the nature of the error being captured. If no type fits, add a new enum here and update raise_error.py to handle it.

Types of validation errors:

  • INVALID_VALUE -> One or more schema fields are invalid (e.g. incorrect type or format)

  • UNKNOWN_FIELD -> A least one unrecognized schema parameter is specified

  • MISSING_FIELD -> At least one required schema parameter is missing

  • FILE_OR_FOLDER_NOT_FOUND -> One or more files or folder paths do not exist

  • CANNOT_SERIALIZE -> Same as "Cannot dump". One or more fields cannot be serialized by marshmallow.

  • CANNOT_PARSE -> YAML file cannot be parsed

  • RESOURCE_NOT_FOUND -> Resource could not be found

  • GENERIC -> Undefined placeholder. Avoid using.

Inheritance
Enum
ValidationErrorType

Constructor

ValidationErrorType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Fields

CANNOT_PARSE
CANNOT_SERIALIZE
FILE_OR_FOLDER_NOT_FOUND
GENERIC
INVALID_VALUE
MISSING_FIELD
RESOURCE_NOT_FOUND
UNKNOWN_FIELD