RefResolver deprecation docs are confusing and do not explain how to replace a very simple usage (a RefResolver which just specifies a base_uri)

[AdamWill]

While running tests on https://pagure.io/fedora-qa/os-autoinst-distri-fedora , I noticed a deprecation warning:

  /home/adamw/local/os-autoinst-distri-fedora/fifloader.py:105: DeprecationWarning: jsonschema.RefResolver is deprecated as of v4.18.0, in favor of the https://github.com/python-jsonschema/referencing library, which provides more compliant referencing behavior as well as more flexible APIs for customization. A future release will remove RefResolver. Please file a feature request (on referencing) if you are missing an API for the kind of customization you need.
    resolver = jsonschema.RefResolver(base_uri, None)

So I went to look at the docs to try and resolve it. All we are doing is using a RefResolver which specifies a local file path to resolve references: the project has a directory with a bunch of schema files in it, and some of them reference others of them. All I need is for jsonschema.validate to know that it should just look in the same directory when resolving these references, so all we do is find that directory and pass it as the first argument to the RefResolver instance.

The deprecation notice points me to https://github.com/python-jsonschema/referencing , which explains the referencing library in great detail but really doesn't help me figure out how the heck to use it to replace this very simple RefResolver usage. Googling around brings me to https://python-jsonschema.readthedocs.io/en/latest/referencing/ , which likewise goes into a ton of confusing detail on other scenarios but doesn't seem to provide any obvious help for mine. It even has a "Migrating from RefResolver" section, which also does not seem to cover this scenario at all.

It'd be great if any of these docs helped me figure out how to survive this deprecation :| thanks a lot!

[AdamWill]

I did try just taking the RefResolver out entirely and hoping jsonschema would figure it out itself somehow, but no joy, that fails with a zillion Unresolvable: (filename).json errors.

[Julian]

I'm on vacation so it will likely be a few weeks before I look at what you wrote, but I suspect you're probably in the first case on the page, namely this where you can simply read each of your files and populate a registry with them ahead of time.

[danka12324]

According to the jsonschema documentation, starting with version 4.18.0, the RefResolver class has been deprecated. Instead, it is proposed to use the referencing library, which provides more compatible reference methods and more flexible APIs for customization. However, despite the availability of detailed documentation on referencing, it can be difficult to immediately figure out how to replace the simple case of using RefResolver.

For your case where you just need to jsonschema.validate knew where to look for schemas, you can use the JsonRefs context manager, which automatically adjusts the reference for the current context. Here is an example of how this can be implemented:

import json
import jsonschema
from jsonschema import Draft7Validator
from jsonschema.validators import Validator
from jsonschema.exceptions import best_match
from jsonschema.compat import JsonRefs

schema_dir = '/path/to/your/schemas/'

with JsonRefs(refs_resolver=lambda ref: open(schema_dir + ref)) as refs:
validator = Va

[djmattyg007]

Was this reply written by ChatGPT or Github Copilot?

[AdamWill]

thanks for the info folks, I will try to get it going using those pointers.