Use the new 'referencing' implementation in 'jsonschema' #289
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There's a new implementation of ref resolution in newer versions of 'jsonschema'. Upgrade to use this, plus add support for loading YAML, JSON5, and TOML schemas as references (so long as they have the filetype suffixes which make them easily detectable).
`referencing` does not support 3.7, which means that supporting 3.7 would start to require separate compatibility code precisely when it has just reached EOL (4 weeks ago at time of writing). Drop 3.7 and move the 'mindeps' builds to 3.8
Also setup a pyright tox environment for testing and usage.
URL joining needs to be done between any relative ref paths and the base URI. This was not correct, as revealed by a new testcase. After fixing, this revealed that the local file loading was somewhat indirect in a way that it no longer needs to be, so local file handling in the ref resolver has been refactored as well.
Relative dyanicRef usage was resolved incorrectly in the prior implementation, but it has been fixed by correct use of `referencing`. Test to ensure that this case is satisfied. See also: #293
Ensure that the `$id` and retrieval URI handling are both done correctly. JSON Schema specifies that `$id` has precedence, so one of the tests confirms that preference.
The retrieval URI was internally called the 'ref base' or 'schema URI', both of which suggest that it is definitively the base URI used for reference resolution. This makes it confusing that adjusting this URI might not change the base URI used. Instead, call it properly 'retrieval URI'. Base URI is newly introduced inside of the retrieve callback, after receiving both the `$id` (if any) and the retrieval URI.
for more information, see https://pre-commit.ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change drops py3.7 (not supported by 'referencing' and EOL) and switches the implementation to 'referencing'.
Because the way that
$refretrieval works has changed, it unlocks the possibility of having.yamlschemas which refer to other.yamlfiles as subschemas, etc. This has been implemented, rather than retaining the prior "reject with a warning" behavior for YAML, TOML, and JSON5.I'd like to see this work in CI at the very least and potentially add some newer test cases to see if I can break it. In particular, there's a bit of mushy
$idandschema_urihandling, which I'd like to check withresponses.