Open Vidminas opened 1 year ago
The first thing to do here is to have a look at #1026 / #1002 / #812 / #698, which are the current open issues relating to improvements to the best_match
heuristic, and see whether implementing any of them would improve your error message.
Have a look and lemme know if any seem relevant.
Hello!
I noticed that in schemas using 'allOf' and unevaluatedProperties, when there is an error in a subschema, instead of showing the relevant error, unevaluatedProperties is (sometimes?) shown instead. This makes it really hard to see what went wrong in anything larger than trivial examples. This seems to be related to https://github.com/python-jsonschema/jsonschema/issues/1074, just with a different scenario.
Here is a small example:
Which produces the error trace:
If I validate instead using:
Then the raised error is much more helpful:
Seems like this happens because
jsonschema.validate
is equivalent toraise best_match(jsonschema.Draft202012Validator(schema).iter_errors(obj))
in this case, and thebest_match
heuristic downgrades any errors coming from 'allOf' and 'oneOf'. With a more complex schema, I get an unevaluatedProperties error using both approaches.3 ways of going about it could be: 1) The suggestion from https://github.com/python-jsonschema/jsonschema/issues/1074 to separately keep track of unevaluated properties and invalid properties, and write different error messages for them.
2) Add properties to evaluated keys even if there are errors resulting from
validator.descend
in https://github.com/python-jsonschema/jsonschema/blob/main/jsonschema/_utils.py:This way unevaluatedProperties will not get raised for properties with subschema errors at all (which shouldn't be a problem, because it'll get raised when those errors are fixed).
3) Make
unevaluatedProperties
messages even weaker than "allOf" and "anyOf" related errors in https://github.com/python-jsonschema/jsonschema/blob/main/jsonschema/exceptions.py#L19I'd be happy to attempt a PR; do you have any thoughts about which approach is best?