Implement 'humanize_error' for voluptuous' validation

[jeff1evesque]

We need to implement MultipleInvalid for our voluptuous validation, since we are currently implementing the except Exception, error case, which only generates a single error, when many could be possible:

root@trusty64:/home/vagrant# cat test.py
from voluptuous import Schema, Required, All, Length, Range, MultipleInvalid

schema = Schema({
    Required('q'): All(str, Length(min=1)),
    Required('per_page'): All(int, Range(min=1, max=20)),
    Required('page'): All(int, Range(min=0)),
})


print('1: ==============================================')

try:
    schema({})
except MultipleInvalid as e:
    print e.errors

print('2: ==============================================')

try:
    schema({})
except Exception, error:
    print error

print('3: ==============================================')

try:
    schema({'q': 123})
except MultipleInvalid as e:
    print e.errors

print('4: ==============================================')

try:
    schema({'q': 123})
except Exception, error:
    print error
root@trusty64:/home/vagrant#
root@trusty64:/home/vagrant#
root@trusty64:/home/vagrant#
root@trusty64:/home/vagrant# python test.py
1: ==============================================
[RequiredFieldInvalid('required key not provided',), RequiredFieldInvalid('required key not provided',), RequiredFieldInvalid('required key not provided',)]
2: ==============================================
required key not provided @ data['q']
3: ==============================================
[TypeInvalid('expected str',), RequiredFieldInvalid('required key not provided',), RequiredFieldInvalid('required key not provided',)]
4: ==============================================
expected str for dictionary value @ data['q']
root@trusty64:/home/vagrant#

[ghost]

Your issue doesn't follow our guidelines. Please fix the following:

• Issue title must be shorter than 55 characters (?)

Click here for details.

Thank you! 🙏

_{This comment was made by GitMagic – Magically enforcing your contribution guidelines.}

[ghost]

Thank you, everything looks good now!

[jeff1evesque]

The humanize_error is more useful, since it provides the corresponding error(s):

root@trusty64:/home/vagrant# cat test.py
from voluptuous import Schema, Required, All, Length, Range
from voluptuous.humanize import humanize_error

schema = Schema({
    Required('q'): All(str, Length(min=1)),
    Required('per_page'): All(int, Range(min=1, max=20)),
    Required('page'): All(int, Range(min=0)),
})

try:
    data = {'q': 123}
    schema(data)
except Exception as e:
    print humanize_error(data, e)
root@trusty64:/home/vagrant#
root@trusty64:/home/vagrant#
root@trusty64:/home/vagrant#
root@trusty64:/home/vagrant# python test.py
expected str for dictionary value @ data['q']. Got 123
required key not provided @ data['page']. Got None
required key not provided @ data['per_page']. Got None

[jeff1evesque]

For the dataset validation, we should include the corresponding dependent-variable value, with the corresponding error, since a given dataset could have multiple dependent-variables, each with multiple nested independent variables. Without being explicit, we may not know if an independent variable error is associated with a given dependent-variable.

[jeff1evesque]

We actually decided to implement validate_with_humanized_errors, so that errors are formatted into verbose syntax, rather than converting the corresponding error messages into verbose syntax.