From 0b64ff485398e2dbe58c078b2eaee56af5944db5 Mon Sep 17 00:00:00 2001 From: Julian Berman Date: Wed, 15 Mar 2023 15:26:59 -0400 Subject: Add 2 more minor deprecations to the changelog. --- CHANGELOG.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 63c89cc..fd4698f 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,9 @@ v4.18.0 ======= +This release majorly rehaul's the way in which JSON Schema reference resolution is configured. +It does so in a way that *should* be backwards compatible, preserving old behavior whilst emitting deprecation warnings. + * ``jsonschema.RefResolver`` is now deprecated in favor of the new `referencing library `_. ``referencing`` will begin in beta, but already is more compliant than the existing ``$ref`` support. This change is a culmination of a meaningful chunk of work to make ``$ref`` resolution more flexible and more correct. @@ -10,6 +13,14 @@ v4.18.0 This should not be a "visible" change in the sense that ``requires-python`` has been updated, so users using 3.7 should still receive ``v4.17.3`` when installing the library. * On draft 2019-09, ``unevaluatedItems`` now properly does *not* consider items to be evaluated by an ``additionalItems`` schema if ``items`` is missing from the schema, as the specification says in this case that ``additionalItems`` must be completely ignored. +Deprecations +------------ + +* ``jsonschema.RefResolver`` -- see above for details on the replacement +* ``jsonschema.RefResolutionError`` -- see above for details on the replacement +* importing ``jsonschema.ErrorTree`` -- instead import it via ``jsonschema.exceptions.ErrorTree`` +* importing ``jsonschema.FormatError`` -- instead import it via ``jsonschema.exceptions.FormatError`` + v4.17.3 ======= -- cgit v1.2.1