Add extra_info on ValidationError for required missing property

[TsankoBg]

This PR adds an extra_info attribute on ValidationError, which is used to indicate the missing property in errors from the required validator.

This should resolve issue #119, and can be used for adding details to other validators as well, in the future.

[codecov]

Codecov Report

Merging #856 (6474476) into main (2cf3dc2) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #856      +/-   ##
==========================================
+ Coverage   98.29%   98.31%   +0.01%     
==========================================
  Files          19       19              
  Lines        3111     3144      +33     
  Branches      377      379       +2     
==========================================
+ Hits         3058     3091      +33     
  Misses         41       41              
  Partials       12       12              

Impacted Files	Coverage Δ
jsonschema/_utils.py	98.22% <100.00%> (+0.04%)	⬆️
jsonschema/_validators.py	98.45% <100.00%> (+<0.01%)	⬆️
jsonschema/exceptions.py	97.91% <100.00%> (+0.01%)	⬆️
jsonschema/tests/test_validators.py	98.84% <100.00%> (+0.03%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2cf3dc2...6474476. Read the comment docs.

[Julian]

Thanks! I'll leave detailed notes in a bit, but really happy to see this getting addressed. Two immediate things:

• There are other validators in the title of required, additionalProperties, propertyNames, dependentRequired and any other validators that reference property *names* need a way to indicate the erroring names in ValidationErrors #119. Can you have a look at each of those and make sure they're covered as well?
• There's a page in the docs (errors.rst) which will need updating here to mention the new attribute

[TsankoBg]

• Can you have a look at each of those and make sure they're covered as well?

Yes, I will check them out.

[TsankoBg]

I looked only into: required, additionalProperties, propertyNames, dependentRequired.

Or would you like all named properties to have the extra info attribute? My initial idea was to add it only to the ones in which the path is empty and the property name cannot be retrieved directly.

[Julian]

No I just meant those indeed! That sounds great, will have a look.

[Julian]

@TsankoBg with sincere apologies (since you yourself did everything right here), some other things have recently convinced me to bite the bullet on finally doing #119 (comment) (i.e. doing this via separating out ValidationError). I have some code locally which does so, but needs some tidying. I'm going to close this as yeah I think that's a better direction long term, but I sincerely appreciate sending the PR for what is the longest-running issue here :(