Support version v4.17.3 Jsonschema (#625)

* Test installation with jsonschema v4.17.3

* Adding referencing in requirements

* Reintroduce Resolver

* Fixing typo

* Fixing typo

* Skipping coverage of validate args

* Relaxing constraint on jsonschema to >= 4.17.3

* Rename DEPRECATED to LEGACY, restrict v4.17 to v4.17.3

* Bump version to v0.16.1

* Handle hot fix of jsonschema v4.17

* add or condition on jsonschema version

* Defining jsonschema with condition

* Adding version to requirement

* Reverting requirement on jsonschema to >= 4.17.3

* Testing with 4.17.3

* Reverting jsonschema version to >=4.17.3

* Add extra assert

---------

Co-authored-by: HGSilveri <henrique.silverio@tecnico.ulisboa.pt>

VERSION.txt

@@ -1 +1 @@
-0.16.0
+0.16.1

pulser-core/pulser/json/abstract_repr/validation.py

@@ -13,13 +13,23 @@
 # limitations under the License.
 """Function for validation of JSON serialization to abstract representation."""
 import json
+from importlib.metadata import version
 from typing import Literal
 
 import jsonschema
 from referencing import Registry, Resource
 
-from pulser.json.abstract_repr import SCHEMAS
+from pulser.json.abstract_repr import SCHEMAS, SCHEMAS_PATH
 
+LEGACY_JSONSCHEMA = "4.18" > version("jsonschema") >= "4.17.3"
+RESOLVER = (
+    jsonschema.validators.RefResolver(
+        base_uri=f"{SCHEMAS_PATH.resolve().as_uri()}/",
+        referrer=SCHEMAS["sequence"],
+    )
+    if LEGACY_JSONSCHEMA
+    else None
+)
 REGISTRY: Registry = Registry().with_resources(
     [("device-schema.json", Resource.from_contents(SCHEMAS["device"]))]
 )
@@ -37,5 +47,9 @@ def validate_abstract_repr(
     obj = json.loads(obj_str)
     validate_args = dict(instance=obj, schema=SCHEMAS[name])
     if name == "sequence":
-        validate_args["registry"] = REGISTRY
+        if LEGACY_JSONSCHEMA:  # pragma: no cover
+            validate_args["resolver"] = RESOLVER
+        else:  # pragma: no cover
+            assert RESOLVER is None
+            validate_args["registry"] = REGISTRY
     jsonschema.validate(**validate_args)

pulser-core/requirements.txt

@@ -1,4 +1,5 @@
-jsonschema >= 4.18
+jsonschema >= 4.17.3
+referencing
 matplotlib < 3.8
 # Numpy 1.20 introduces type hints, 1.24.0 breaks matplotlib < 3.6.1
 numpy >= 1.20, != 1.24.0

tests/test_abstract_repr.py

@@ -44,7 +44,11 @@
     AbstractReprEncoder,
     abstract_repr,
 )
-from pulser.json.abstract_repr.validation import REGISTRY
+from pulser.json.abstract_repr.validation import (
+    LEGACY_JSONSCHEMA,
+    REGISTRY,
+    RESOLVER,
+)
 from pulser.json.exceptions import AbstractReprError, DeserializeDeviceError
 from pulser.parametrized.decorators import parametrize
 from pulser.parametrized.paramobj import ParamObj
@@ -278,7 +282,16 @@ def validate_schema(instance):
         encoding="utf-8",
     ) as f:
         schema = json.load(f)
-    jsonschema.validate(instance=instance, schema=schema, registry=REGISTRY)
+    if LEGACY_JSONSCHEMA:
+        assert RESOLVER is not None
+        jsonschema.validate(
+            instance=instance, schema=schema, resolver=RESOLVER
+        )
+    else:
+        assert RESOLVER is None
+        jsonschema.validate(
+            instance=instance, schema=schema, registry=REGISTRY
+        )
 
 
 class TestSerialization: