jsonschema

What's Changed

• Fix Validator protocol init to match runtime by @sirosen in #1396

Full Changelog: v4.25.0...v4.25.1

What's Changed

• Add support for the iri and iri-reference formats to the format-nongpl extra by @jkowalleck in #1388

New Contributors

• @jkowalleck made their first contribution in #1388

Full Changelog: v4.24.1...v4.25.0

What's Changed

• Unambiguously quote and escape properties in JSON path rendering by @kurtmckee in #1390
• Drop python<3.9 backports by @hackowitz-af in #1367

New Contributors

• @hackowitz-af made their first contribution in #1367
• @kurtmckee made their first contribution in #1390

Full Changelog: v4.24.0...v4.24.1

What's Changed

• Fix calculation of evaluated properties by @V02460 in #1351
• Support for Python 3.8 has been dropped, as it is end-of-life.

New Contributors

• @bkueng made their first contribution in #1326
• @V02460 made their first contribution in #1351

Full Changelog: v4.23.0...v4.24.0

What's Changed

• Add some typing to the exceptions.py module by @DanielNoord in #1019
• Declare support for 3.13 by @rominf in #1282

New Contributors

• @rominf made their first contribution in #1282

Full Changelog: v4.22.0...v4.23.0

What's Changed

• Improve best_match (and thereby error messages from jsonschema.validate) in cases where there are multiple sibling errors from applying anyOf / allOf -- i.e. when multiple elements of a JSON array have errors, we now do prefer showing errors from earlier elements rather than simply showing an error for the full array (#1250).
• (Micro-)optimize equality checks when comparing for JSON Schema equality by first checking for object identity, as == would.

New Contributors

• @shinnar made their first contribution in #1224

Full Changelog: v4.21.1...v4.22.0

• Slightly speed up the contains keyword by removing some unnecessary validator (re-)creation.

Full Changelog: v4.21.0...v4.21.1

What's Changed

• Fix the behavior of enum in the presence of 0 or 1 to properly consider True and False unequal (#1208).
• Special case the error message for {min,max}{Items,Length,Properties} when they're checking for emptiness rather than true length.

New Contributors

• @otto-ifak made their first contribution in #1208

Full Changelog: v4.20.0...v4.21.0

• Properly consider items (and properties) to be evaluated by unevaluatedItems (resp. unevaluatedProperties) when behind a $dynamicRef as specified by the 2020 and 2019 specifications.
• jsonschema.exceptions.ErrorTree.__setitem__ is now deprecated. More broadly, in general users of jsonschema should never be mutating objects owned by the library.

Full Changelog: v4.19.2...v4.20.0

<!-- Release notes generated using configuration in .github/release.yml at v4.19.2 -->

• Fix the error message for additional items when used with heterogeneous arrays.
• Don't leak the additionalItems keyword into JSON Schema draft 2020-12, where it was replaced by items.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.19.1...v4.19.2

<!-- Release notes generated using configuration in .github/release.yml at v4.19.1 -->

What's Changed

• Allow single label hostname in format string by @swaeberle in https://github.com/python-jsonschema/jsonschema/pull/1164

New Contributors

• @swaeberle made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/1164

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.19.0...v4.19.1

<!-- Release notes generated using configuration in .github/release.yml at v4.19.0 -->

• Importing the Validator protocol directly from the package root is deprecated. Import it from jsonschema.protocols.Validator instead.
• Automatic retrieval of remote references (which is still deprecated) now properly succeeds even if the retrieved resource does not declare which version of JSON Schema it uses. Such resources are assumed to be 2020-12 schemas. This more closely matches the pre-referencing library behavior.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.6...v4.19.0

<!-- Release notes generated using configuration in .github/release.yml at v4.18.6 -->

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.5...v4.18.6

<!-- Release notes generated using configuration in .github/release.yml at v4.18.5 -->

• Declare support for Py3.12

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.4...v4.18.5

<!-- Release notes generated using configuration in .github/release.yml at v4.18.4 -->

• Improve the hashability of wrapped referencing exceptions when they contain hashable data.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.3...v4.18.4

<!-- Release notes generated using configuration in .github/release.yml at v4.18.3 -->

• Properly preserve applicable_validators in extended validators. Specifically, validators extending early drafts where siblings of $ref were ignored will properly ignore siblings in the extended validator.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.2...v4.18.3

<!-- Release notes generated using configuration in .github/release.yml at v4.18.2 -->

• Fix an additional regression with the deprecated jsonschema.RefResolver and pointer resolution.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.1...v4.18.2

<!-- Release notes generated using configuration in .github/release.yml at v4.18.1 -->

• Fix a regression with jsonschema.RefResolver based resolution when used in combination with a custom validation dialect (via jsonschema.validators.create).

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.0...v4.18.1

What's Changed

This release majorly rehauls 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. Backwards compatibility should be preserved for existing code which uses RefResolver, though doing so is again now deprecated, and all such use cases should be doable using the new APIs. Please file issues on the referencing tracker if there is functionality missing from it, or here on the jsonschema issue tracker if you have issues with existing code not functioning the same, or with figuring out how to change it to use referencing. In particular, this referencing change includes a change concerning automatic retrieval of remote references (retrieving http://foo/bar automatically within a schema). This behavior has always been a potential security risk and counter to the recommendations of the JSON Schema specifications; it has survived this long essentially only for backwards compatibility reasons, and now explicitly produces warnings. The referencing library itself will not automatically retrieve references if you interact directly with it, so the deprecated behavior is only triggered if you fully rely on the default $ref resolution behavior and also include remote references in your schema, which will still be retrieved during the deprecation period (after which they will become an error).
• Support for Python 3.7 has been dropped, as it is nearing end-of-life. 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.
• Fix the date format checker on Python 3.11 (when format assertion behavior is enabled), where it was too liberal (#1076).
• Speed up validation of unevaluatedProperties (#1075).

Deprecations

• jsonschema.RefResolver -- see above for details on the replacement
• jsonschema.RefResolutionError -- see above for details on the replacement
• relying on automatic resolution of remote references -- 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

New Contributors

• @DanielNoord made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/1021
• @aryanA101a made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/1063
• @jvtm made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/1076
• @ikonst made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/1075

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.17.3...v4.18.0

<!-- Release notes generated using configuration in .github/release.yml at v4.18.0a10 -->

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.0a9...v4.18.0a10

<!-- Release notes generated using configuration in .github/release.yml at v4.18.0a9 -->

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.0a8...v4.18.0a9

<!-- Release notes generated using configuration in .github/release.yml at v4.18.0a8 -->

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.0a7...v4.18.0a8

<!-- Release notes generated using configuration in .github/release.yml at v4.18.0a7 -->

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.0a6...v4.18.0a7

<!-- Release notes generated using configuration in .github/release.yml at v4.18.0a6 -->

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.0a5...v4.18.0a6

<!-- Release notes generated using configuration in .github/release.yml at v4.18.0a5 -->

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.0a4...v4.18.0a5

<!-- Release notes generated using configuration in .github/release.yml at v4.18.0a4 -->

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.0a3...v4.18.0a4

<!-- Release notes generated using configuration in .github/release.yml at v4.18.0a3 -->

What's Changed

• fix: Python 3.11 date.fromisoformat() allows extra formats by @jvtm in https://github.com/python-jsonschema/jsonschema/pull/1076
• Do not validate for unevaluatedProperties by @ikonst in https://github.com/python-jsonschema/jsonschema/pull/1075

New Contributors

• @jvtm made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/1076
• @ikonst made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/1075

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.0a2...v4.18.0a3

What's Changed

• documentation mistype fix by @aryanA101a in https://github.com/python-jsonschema/jsonschema/pull/1063

New Contributors

• @aryanA101a made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/1063

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.18.0a1...v4.18.0a2

What's Changed

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. Backwards compatibility should be preserved for existing code which uses RefResolver, though doing so is again now deprecated, and all such use cases should be doable using the new APIs. Please file issues on the referencing tracker if there is functionality missing from it, or here on the jsonschema issue tracker if you have issues with existing code not functioning the same, or with figuring out how to change it to use referencing.

For full details see the new referencing documentation.

Further changes

• Support for Python 3.7 has been dropped, as it is nearing end-of-life. 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.
• A small number of type annotations have been improved
• 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

New Contributors

• @DanielNoord made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/1021

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.17.3...v4.18.0a1

• Fix instantiating validators with cached refs to boolean schemas rather than objects (#1018).
• Empty strings are not valid relative JSON Pointers (aren't valid under the RJP format).
• Durations without (trailing) units are not valid durations (aren't valid under the duration format). This involves changing the dependency used for validating durations (from isoduration to isodate).

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.17.2...v4.17.3

• The error message when using unevaluatedProperties with a non-trivial schema value (i.e. something other than false) has been improved (#996).

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.17.0...v4.17.1

• The check_schema method on jsonschema.protocols.Validator instances now enables format validation by default when run. This can catch some additional invalid schemas (e.g. containing invalid regular expressions) where the issue is indeed uncovered by validating against the metaschema with format validation enabled as an assertion.
• The jsonschema CLI (along with jsonschema.cli the module) are now deprecated. Use check-jsonschema instead, which can be installed via pip install check-jsonschema and found here.
• Make ErrorTree have a more grammatically correct repr.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.16.0...v4.17.0

• Improve the base URI behavior when resolving a $ref to a resolution URI which is different from the resolved schema's declared $id.
• Accessing jsonschema.draftN_format_checker is deprecated. Instead, if you want access to the format checker itself, it is exposed as jsonschema.validators.DraftNValidator.FORMAT_CHECKER on any jsonschema.protocols.Validator.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.15.0...v4.16.0

What's Changed

• Enable dedicated API documentation page(s) by @Julian in https://github.com/python-jsonschema/jsonschema/pull/989

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.14.0...v4.15.0

• FormatChecker.cls_checks is deprecated. Use FormatChecker.checks on an instance of FormatChecker instead.
• unevaluatedItems has been fixed for draft 2019. It's nonetheless discouraged to use draft 2019 for any schemas, new or old.
• Fix a number of minor annotation issues in protocols.Validator

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.13.0...v4.14.0

• Add support for creating validator classes whose metaschema uses a different dialect than its schemas. In other words, they may use draft2020-12 to define which schemas are valid, but the schemas themselves use draft7 (or a custom dialect, etc.) to define which instances are valid. Doing this is likely not something most users, even metaschema authors, may need, but occasionally will be useful for advanced use cases.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.12.1...v4.13.0

What's Changed

• Use rST markers in README by @hynek in https://github.com/python-jsonschema/jsonschema/pull/987

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.12.0...v4.12.1

• Warn at runtime when subclassing validator classes. Doing so was not intended to be public API, though it seems some downstream libraries do so. A future version will make this an error, as it is brittle and better served by composing validator objects instead. Feel free to reach out if there are any cases where changing existing code seems difficult and I can try to provide guidance.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.11.0...v4.12.0

What's Changed

• jsonschema deserves a ✨fancy✨ readme by @hynek in https://github.com/python-jsonschema/jsonschema/pull/983

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.10.3...v4.11.0

• jsonschema.validators.validator_for now properly uses the explicitly provided default validator even if the $schema URI is not found.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.10.2...v4.10.3

• Fix a second place where subclasses may have added attrs attributes (#982).

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.10.1...v4.10.2

• Fix Validator.evolve (and APIs like iter_errors which call it) for cases where the validator class has been subclassed. Doing so wasn't intended to be public API, but given it didn't warn or raise an error it's of course understandable. The next release however will make it warn (and a future one will make it error). If you need help migrating usage of inheriting from a validator class feel free to open a discussion and I'll try to give some guidance (#982).

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.10.0...v4.10.1

• Add support for referencing schemas with $ref across different versions of the specification than the referrer's

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.9.1...v4.10.0

• Update some documentation examples to use newer validator releases in their sample code.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.9.0...v4.9.1

• Fix relative $ref resolution when the base URI is a URN or other scheme (#544).
• pkgutil.resolve_name is now used to retrieve validators provided on the command line. This function is only available on 3.9+, so 3.7 and 3.8 (which are still supported) now rely on the pkgutil_resolve_name <https://pypi.org/project/pkgutil_resolve_name/>_ backport package. Note however that the CLI itself is due to be deprecated shortly in favor of check-jsonschema <https://github.com/python-jsonschema/check-jsonschema>_.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.8.0...v4.9.0

• best_match no longer traverses into anyOf and oneOf when all of the errors within them seem equally applicable. This should lead to clearer error messages in some cases where no branches were matched.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.7.2...v4.8.0

• Also have best_match handle cases where the type validator is an array.

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.7.1...v4.7.2

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.7.0...v4.7.1

What's Changed

• Enhance best match to prefer errors from matching types. by @Julian in https://github.com/python-jsonschema/jsonschema/pull/972

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.6.2...v4.7.0

What's Changed

• docs: Fix a few typos by @timgates42 in https://github.com/python-jsonschema/jsonschema/pull/969

New Contributors

• @timgates42 made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/969

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.6.1...v4.6.2

What's Changed

• Type annotate format checker methods by @sirosen in https://github.com/python-jsonschema/jsonschema/pull/958
• Fix fuzzer to include instrumentation by @DavidKorczynski in https://github.com/python-jsonschema/jsonschema/pull/965
• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/python-jsonschema/jsonschema/pull/967

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.6.0...v4.6.1

What's Changed

• Add package_url for changelog by @fhightower in https://github.com/python-jsonschema/jsonschema/pull/950
• Only validate unevaluated properties/items on applicable types by @EpicWink in https://github.com/python-jsonschema/jsonschema/pull/949
• Add v4.5.1 to changelog by @sirosen in https://github.com/python-jsonschema/jsonschema/pull/956
• Modernize the packaging setup via PEP 621 and Hatch. by @Julian in https://github.com/python-jsonschema/jsonschema/pull/957

New Contributors

• @fhightower made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/950
• @EpicWink made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/949

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.5.1...v4.6.0

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.5.0...v4.5.1

What's Changed

• Extend dynamicRef keyword by @nezhar in https://github.com/python-jsonschema/jsonschema/pull/886
• Add FORMAT_CHECKER attribute for Validator by @TiborVoelcker in https://github.com/python-jsonschema/jsonschema/pull/905
• Remove stray double-quote by @lurch in https://github.com/python-jsonschema/jsonschema/pull/926
• Ensure proper sorting of list in error message by @ssbarnea in https://github.com/python-jsonschema/jsonschema/pull/940

New Contributors

• @TiborVoelcker made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/905
• @lurch made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/926
• @ssbarnea made their first contribution in https://github.com/python-jsonschema/jsonschema/pull/940

Full Changelog: https://github.com/python-jsonschema/jsonschema/compare/v4.4.0...v4.5.0

What's Changed

• Setup mypy in tox -e typing and get it to pass by @sirosen in https://github.com/Julian/jsonschema/pull/892

Full Changelog: https://github.com/Julian/jsonschema/compare/v4.3.3...v4.4.0

What's Changed

• [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/Julian/jsonschema/pull/897
• Move warnings to user context by @Kojoley in https://github.com/Julian/jsonschema/pull/899

New Contributors

• @Kojoley made their first contribution in https://github.com/Julian/jsonschema/pull/899

Full Changelog: https://github.com/Julian/jsonschema/compare/v4.3.2...v4.3.3

What's Changed

• perf: Cache subschemas by @Stranger6667 in https://github.com/Julian/jsonschema/pull/896

Full Changelog: https://github.com/Julian/jsonschema/compare/v4.3.1...v4.3.2

What's Changed

• perf: Cache reference lookups for subschemas by @Stranger6667 in https://github.com/Julian/jsonschema/pull/894

Full Changelog: https://github.com/Julian/jsonschema/compare/v4.3.0...v4.3.1

What's Changed

• perf: Undesired fallback to brute force container uniqueness check on certain input types by @Stranger6667 in https://github.com/Julian/jsonschema/pull/893
• Add jsonschema.protocols.IValidator by @sirosen in https://github.com/Julian/jsonschema/pull/890

New Contributors

• @Stranger6667 made their first contribution in https://github.com/Julian/jsonschema/pull/893
• @sirosen made their first contribution in https://github.com/Julian/jsonschema/pull/890

Full Changelog: https://github.com/Julian/jsonschema/compare/v4.2.1...v4.3.0