Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pin jsonschema to latest version 4.19.0 #75

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

pyup-bot
Copy link
Collaborator

@pyup-bot pyup-bot commented Aug 7, 2023

This PR pins jsonschema to the latest release 4.19.0.

Changelog

4.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.

4.18.6

=======

* Set a ``jsonschema`` specific user agent when automatically retrieving remote references (which is deprecated).

4.18.5

=======

* Declare support for Py3.12

4.18.4

=======

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

4.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.

4.18.2

=======

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

4.18.1

=======

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

4.18.0

=======

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 <https://github.com/python-jsonschema/referencing/>`_.
``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``

4.17.3

=======

* Fix instantiating validators with cached refs to boolean schemas
rather than objects (1018).

4.17.2

=======

* 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``).

4.17.1

=======

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

4.17.0

=======

* 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 <https://github.com/python-jsonschema/check-jsonschema>`_.

4.16.1

=======

* Make ``ErrorTree`` have a more grammatically correct ``repr``.

4.16.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``.

4.15.0

=======

* A specific API Reference page is now present in the documentation.
* ``$ref`` on earlier drafts (specifically draft 7 and 6) has been "fixed" to
follow the specified behavior when present alongside a sibling ``$id``.
Specifically the ID is now properly ignored, and references are resolved
against whatever resolution scope was previously relevant.

4.14.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``

4.13.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.

4.12.1

=======

* Fix some stray comments in the README.

4.12.0

=======

* 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.

4.11.0

=======

* Make the rendered README in PyPI simpler and fancier. Thanks Hynek (983)!

4.10.3

=======

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

4.10.2

=======

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

4.10.1

=======

* 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).

4.10.0

=======

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

4.9.1

======

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

4.9.0

======

* 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>`_.

4.8.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.

4.7.2

======

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

4.7.1

======

* Minor tweak of the PyPI hyperlink names

4.7.0

======

* Enhance ``best_match`` to prefer errors from branches of the schema which
match the instance's type (728)

4.6.2

======

* Fix a number of minor typos in docstrings, mostly private ones (969)

4.6.1

======

* Gut the (incomplete) implementation of ``recursiveRef`` on draft 2019. It
needs completing, but for now can lead to recursion errors (e.g. 847).

4.6.0

======

* Fix ``unevaluatedProperties`` and ``unevaluatedItems`` for types they should
ignore (949)
* ``jsonschema`` now uses `hatch <https://hatch.pypa.io/>`_ for its build
process. This should be completely transparent to end-users (and only matters
to contributors).

4.5.1

======

* Revert changes to ``$dynamicRef`` which caused a performance regression
in v4.5.0

4.5.0

======

* Validator classes for each version now maintain references to the correct
corresponding format checker (905)
* Development has moved to a `GitHub organization
<https://github.com/python-jsonschema/>`_.
No functional behavior changes are expected from the change.

4.4.0

======

* Add ``mypy`` support (892)
* Add support for Python 3.11

4.3.3

======

* Properly report deprecation warnings at the right stack level (899)

4.3.2

======

* Additional performance improvements for resolving refs (896)

4.3.1

======

* Resolving refs has had performance improvements (893)

4.3.0

======

* Fix undesired fallback to brute force container uniqueness check on
certain input types (893)
* Implement a PEP544 Protocol for validator classes (890)

4.2.1

======

* Pin ``importlib.resources`` from below (877)

4.2.0

======

* Use ``importlib.resources`` to load schemas (873)
* Ensure all elements of arrays are verified for uniqueness by ``uniqueItems``
(866)

4.1.2

======

* Fix ``dependentSchemas`` to properly consider non-object instances to be
valid (850)

4.1.1

======

* Fix ``prefixItems`` not indicating which item was invalid within the instance
path (862)

4.1.0

======

* Add Python 3.10 to the list of supported Python versions

4.0.1

======

* Fix the declaration of minimum supported Python version (846)

4.0.0

======

* Partial support for Draft 2020-12 (as well as 2019-09).
Thanks to Thomas Schmidt and Harald Nezbeda.
* ``False`` and ``0`` are now properly considered non-equal even
recursively within a container (686). As part of this change,
``uniqueItems`` validation may be *slower* in some cases. Please feel
free to report any significant performance regressions, though in
some cases they may be difficult to address given the specification
requirement.
* The CLI has been improved, and in particular now supports a ``--output``
option (with ``plain`` (default) or ``pretty`` arguments) to control the
output format. Future work may add additional machine-parsable output
formats.
* Code surrounding ``DEFAULT_TYPES`` and the legacy mechanism for
specifying types to validators have been removed, as per the deprecation
policy. Validators should use the ``TypeChecker`` object to customize
the set of Python types corresponding to JSON Schema types.
* Validation errors now have a ``json_path`` attribute, describing their
location in JSON path format
* Support for the IP address and domain name formats has been improved
* Support for Python 2 and 3.6 has been dropped, with ``python_requires``
properly set.
* ``multipleOf`` could overflow when given sufficiently large numbers. Now,
when an overflow occurs, ``jsonschema`` will fall back to using fraction
division (746).
* ``jsonschema.__version__``, ``jsonschema.validators.validators``,
``jsonschema.validators.meta_schemas`` and
``jsonschema.RefResolver.in_scope`` have been deprecated, as has
passing a second-argument schema to ``Validator.iter_errors`` and
``Validator.is_valid``.

3.2.0

======

* Added a ``format_nongpl`` setuptools extra, which installs only ``format``
dependencies that are non-GPL (619).

3.1.1

======

* Temporarily revert the switch to ``js-regex`` until 611 and 612 are
resolved.

3.1.0

======

* Regular expressions throughout schemas now respect the ECMA 262 dialect, as
recommended by the specification (609).

3.0.2

======

* Fixed a bug where ``0`` and ``False`` were considered equal by
``const`` and ``enum`` (575).

3.0.1

======

* Fixed a bug where extending validators did not preserve their notion
of which validator property contains ``$id`` information.

3.0.0

======

* Support for Draft 6 and Draft 7
* Draft 7 is now the default
* New ``TypeChecker`` object for more complex type definitions (and overrides)
* Falling back to isodate for the date-time format checker is no longer
attempted, in accordance with the specification

2.6.0

======

* Support for Python 2.6 has been dropped.
* Improve a few error messages for ``uniqueItems`` (224) and
``additionalProperties`` (317)
* Fixed an issue with ``ErrorTree``'s handling of multiple errors (288)

2.5.0

======

* Improved performance on CPython by adding caching around ref resolution
(203)

2.4.0

======

* Added a CLI (134)
* Added absolute path and absolute schema path to errors (120)
* Added ``relevance``
* Meta-schemas are now loaded via ``pkgutil``

2.3.0

======

* Added ``by_relevance`` and ``best_match`` (91)
* Fixed ``format`` to allow adding formats for non-strings (125)
* Fixed the ``uri`` format to reject URI references (131)

2.2.0

======

* Compile the host name regex (127)
* Allow arbitrary objects to be types (129)

2.1.0

======

* Support RFC 3339 datetimes in conformance with the spec
* Fixed error paths for additionalItems + items (122)
* Fixed wording for min / maxProperties (117)

2.0.0

======

* Added ``create`` and ``extend`` to ``jsonschema.validators``
* Removed ``ValidatorMixin``
* Fixed array indices ref resolution (95)
* Fixed unknown scheme defragmenting and handling (102)

1.3.0

======

* Better error tracebacks (83)
* Raise exceptions in ``ErrorTree``\s for keys not in the instance (92)
* __cause__ (93)

1.2.0

======

* More attributes for ValidationError (86)
* Added ``ValidatorMixin.descend``
* Fixed bad ``RefResolutionError`` message (82)

1.1.0

======

* Canonicalize URIs (70)
* Allow attaching exceptions to ``format`` errors (77)

1.0.0

======

* Support for Draft 4
* Support for format
* Longs are ints too!
* Fixed a number of issues with ``$ref`` support (66)
* Draft4Validator is now the default
* ``ValidationError.path`` is now in sequential order
* Added ``ValidatorMixin``

0.23.3

------

- Update vendored schemas: buildkite, dependabot, github-workflows, gitlab-ci,
readthedocs, renovate (2023-07-11)
- Add Bitbucket Pipelines schema and pre-commit hook. Thanks :user:`djgoku`!
(:pr:`282`)

0.23.2

------
- Update vendored schemas: github-workflow, gitlab-ci, renovate (2023-06-13)
- Fix the handling of malformed and missing ``Last-Modified`` headers in the
caching downloader. Thanks :user:`balihb`! (:issue:`275`)

0.23.1

------

- Update vendored schemas: github-workflows, gitlab-ci, renovate (2023-05-30)
- The schema for enforcing timeout-minutes on GitHub Actions jobs has been
updated to allow for workflow call jobs (which cannot have a timeout)

0.23.0

------

- Update vendored schemas: azure-pipelines, buildkite, dependabot,
github-workflows, gitlab-ci, renovate (2023-05-03)
- A new option, ``--disable-formats`` replaces and enhances the
``--disable-format`` flag. ``--disable-formats`` takes a format to disable
and may be passed multiple times, allowing users to opt out of any specific
format checks. ``--disable-format "*"`` can be used to disable all format
checking. ``--disable-format`` is still supported, but is deprecated and
emits a warning.

0.22.0

------

- Update vendored schemas: buildkite, github-workflows, gitlab-ci, renovate,
travis (2023-03-08)
- The ``check-dependabot`` hook now also supports ``.github/dependabot.yaml``
Thanks :user:`noorul`!
- Fix a mistake in the dependency bound for ``jsonschema``, which was intended
to change in v0.21.0

0.21.0

------

- Update vendored schemas: github-workflows, gitlab-ci, renovate (2023-01-24)
- Fix a bug in which ``--check-metaschema`` was not building validators correctly.
The metaschema's schema dialect is chosen correctly now, and metaschema
formats are now checked by default. This can be disabled with
``--disable-format``.
- Fix the resolution of `$schema` dialect to format checker classes
- Fix package dependency lower bounds, including setting ``jsonschema>=4.5.1``
- Output colorization can now be controlled with
``--color [never|always|auto]``. Thanks :user:`WillDaSilva`!

0.20.0

------

- Update vendored schemas: bamboo-spec, buildkite, dependabot, github-actions,
github-workflows, gitlab-ci, readthedocs, renovate, travis (2023-01-03)
- Add ``--fill-defaults`` argument which eagerly populates ``"default"``
values whenever they are encountered and a value is not already present
(:issue:`200`)
- Add Buildkite schema and pre-commit hook (:issue:`198`)

0.19.2

------

- Update vendored schemas: gitlab-ci, renovate (2022-11-14)
- Downloads of schemas from remote (http/https) locations will now retry if the
downloaded data is not valid JSON (:issue:`183`)
- Remove the deprecated ``--show-all-validation-errors`` option
- Add support for Python 3.11, and ``tomllib`` as an alternative to ``tomli``
- The github-actions hook now requires a filename of ``action.yml`` or
``action.yaml`` for action definitions in ``.github/actions/``, in accordance
with the GitHub Documentation (:pr:`186`)

0.19.1

------

- Fix handling of file descriptors created using the ``/proc/self/fd/``
mechanism (:issue:`176`)

0.19.0

------

- Update vendored schemas: github-workflows, gitlab-ci, renovate (2022-11-10)
- Improve the behaviors of filetype detection. ``--default-filetype`` now
defaults to ``json``, and can be passed ``toml`` or ``json5`` if those
parsers are installed. Detection is now only done by suffix mapping and will
not attempt to read files.

0.18.4

------

- Update vendored schemas: bamboo-spec, dependabot, github-workflows,
gitlab-ci, renovate (2022-10-20)
- Tweak format checker usage to avoid deprecation warning from ``jsonschema``
- The Azure Pipelines data transform is now more permissive, which should allow
it to handle a wider variety of pipelines files (:issue:`162`)

0.18.3

------

- Update vendored schemas: github-actions, github-workflows, renovate, travis
(2022-09-13)

0.18.2

------

- Fix handling of certain YAML parsing errors on bad inputs

0.18.1

------

- Fix erroneous type annotations

0.18.0

------

- Update vendored schemas: azure-pipelines, github-workflows, gitlab-ci,
renovate (2022-08-27)
- When an instancefile is invalid and cannot be parsed, validation is still run
on all other files. The run will be marked as failed, but a more detailed
report will be output, including validation failures on other files
(:issue:`141`)

0.17.1

------

- Update vendored schemas: renovate (2022-07-13)
- Update check-github-worfklows match rule to exclude subdirectories of the
`.github/workflows/` directory. (:issue:`113`)

0.17.0

------

- Update vendored schemas: renovate, travis (2022-06-29)
- Add support for ``--data-transform gitlab-ci``, which enables expansion of the
``!reference`` tag in gitlab CI YAML files. This is now enabled by default on
the gitlab-ci pre-commit hook.
- Support for various file formats has been refactored to share code between
the instance and schema loaders. Schema loading can now support the same
formats as instances with minimal effort.
- Support loading schemas from JSON5 files. Like YAML schemas, this is only
supported for local files and warns if refs to other JSON5 files are used.
- Introduce new documentation site at https://check-jsonschema.readthedocs.io

0.16.2

------

- Update vendored schemas: github-workflows, gitlab-ci, renovate (2022-06-27)
- Fix the behavior of unquoted datetime strings in YAML documents to always
parse as strings, not ``datetime.datetime``. Thanks to :user:`tgillbe` for
the fix! (:issue:`116`)

0.16.1

------

- Update vendored schemas: github-workflows, gitlab-ci, renovate (2022-06-21)

0.16.0

------

- Update vendored schemas: gitlab-ci, renovate (2022-06-06)
- Add support for TOML instance files using ``tomli``. See documentation on
optional parsers for details.
Thanks to :user:`mondeja` for the request and test
data!
- Instance files are now read in binary mode, not UTF-8 encoded
- The behavior of format checkers is now more draft-specific, as
``check-jsonschema`` will now use the appropriate checker for the schema's
dialect as detected via the ``$schema`` attribute

0.15.1

------

- Update vendored schemas: bamboo-spec, dependabot, github-actions,
github-workflows, gitlab-ci, readthedocs, renovate, travis (2022-05-26)
- Add ``check-dependabot`` to supported hooks

0.15.0

------

- Update vendored schemas: renovate, gitlab, github-workflow, github-actions,
azure-pipelines, readthedocs (2022-05-13)
- Use ``click`` to implement CLI parsing. This provides several internal features
as well as shell completion support.
- Add support for ``--version`` as an option
- Add support for the ``NO_COLOR=1``
- When loading schema references, check for a suffix of ``.ya?ml`` and emit a
warning. This does not abort loading the reference.
- When loading YAML instance files, non-string object keys will be stringified.
This makes YAML data better conform to the requirements for JSON Schema.
- Change usage of stderr/stdout to send more of the error information to stdout
and more of the user-messaging to stderr
- Deprecate ``--show-all-validation-errors``. It will be removed in a future
release.
- Add ``-v/--verbose`` and ``-o/--output-format`` to offer better control over
output. ``--verbose`` replaces ``--show-all-validation-errors`` and ``-o`` can be
used to request JSON output as in ``-o JSON``.

0.14.3

------

- Update vendored schemas: renovate, gitlab-ci (2022-04-13)
- ``check-jsonschema`` now treats all instance files as UTF-8, regardless of the
platform and locale. This ensures that files are handled uniformly between
\*nix and Windows

0.14.2

------

- Update vendored schemas: renovate, github-workflows, gitlab-ci (2022-03-30)
- Fix the vendored schema for GitLab to pull from the correct location.
Thanks :user:`dsch` for the fix!

0.14.1

------

- Update vendored schemas: azure-pipelines, renovate (2022-03-17)
- Allow invocation via ``python -m check_jsonschema``

0.14.0

------

- Drop support for python3.6 and improve internal type annotations
- Update vendored schemas (2022-02-28)
- Improve handling of file-URI inputs on Windows
- Add support for a new hook, ``check-metaschema``, which invokes
 ``check-jsonschema --check-metaschema``
- The ``check-jsonschema`` repo has moved to a new home at
 https://github.com/python-jsonschema/check-jsonschema

0.13.0

------

- Add support for ``--check-metaschema``, which validates each instance file as a
 JSON Schema, using the metaschema specified by ``"$schema"``
- ``--builtin-schema`` now validates its arguments (with ``choices=...``), and its
 options are automatically picked up from the internal schema catalog and
 listed in the ``--help`` output

0.12.0

------

- Add support for JSON5 files when ``pyjson5`` or ``json5`` is installed, and
 update the Renovate hook to list JSON5 config files. If a JSON5 file is
 checked without one of the necessary packages installed, a special error
 with installation instructions will be raised
- Add hooks for GitLab CI and Bamboo Specs
- Remove the ``--failover-builtin-schema`` behavior. Now that vendored schemas
are used by default for hooks, this option had very limited utility.
- Update vendored schemas (2022-02-16)

0.11.0

------

- Add support for ``--data-transform azure-pipelines`` to handle compile-time
expressions in Pipelines files. This option is applied to the azure
pipelines hook (:issue:`29`)
- Improve handing of validation errors from schemas with ``anyOf`` and ``oneOf``
clauses. Show the "best match" from underlying errors, and add an option
``--show-all-validation-errors`` which displays all of the underlying errors
- Use vendored schemas in all hooks, not latest schemastore copies. This
ensures that hook behavior is consistent
(:issue:`38`)
- Update vendored schemas (2022-02-12)
- Use ``requests`` to make HTTP requests, and retry request failures

0.10.2

------

- Fix the ``check-renovate`` hook, which was skipping all files. Do not attempt
to check JSON5 files, which are not supported.
Thanks to :user:`tpansino` for the contribution!
- Update vendored schema versions (2022-02-01)

0.10.1

------

- Use pypa's ``build`` tool to build dists
- Update vendored schema versions (2022-01-27)

0.10.0

------

- Support YAML as a format for schema files (local schemas only).
Thanks to :user:`yyuu` for the contribution!

0.9.1

-----

- Update Azure Pipelines and ReadTheDocs hooks to always download latest
schemas (rather than specific versions). This is safe now that they can
failover to builtin schemas
- Update Azure Pipelines schema to latest

0.9.0

-----

- Format checking now has special handling for the ``regex`` format. The default
looks for recognizable syntaxes which indicate the use of an engine-specific
regex feature which cannot be parsed in python. Such regexes are always
treated as valid. To get strict python behavior (the previous behavior), use
``--format-regex=python``. For no regex checking at all, without disabling
other formats, use ``--format-regex=disabled``.
resolves :issue:`20`
- Add a hook for Renovate Bot config, ``check-renovate``. Note that the hook does
not support config in ``package.json`` (all other configuration locations are
supported)

0.8.2

-----

- Add ReadTheDocs hook

0.8.1

-----

- Bugfix for package metadata to include builtin schemas

0.8.0

-----

- ``check-jsonschema`` now ships with vendored versions of the external schemas
used for the default suite of hooks. The vendored schemas are used as a
failover option in the event that downloading an external schema fails. This
resolves :issue:`21`
- New CLI options, ``--builtin-schema`` and ``--failover-builtin-schema`` are
available to access the builtin schemas. See documentation for details.
- Use the latest version (version 4) of the ``jsonschema`` library. Note
that ``jsonschema`` has dropped support for python3.6, and  ``check-jsonschema``
will therefore use ``jsonschema`` version 3 when running on python3.6
- The path shown in error messages is now a valid
`JSONPath <https://goessner.net/articles/JsonPath/>`_ expression

0.7.1

-----

- Bugfix: validation errors were not being displayed correctly.
- Errors are now sent to stderr instead of stdout.

0.7

====

* Partial support for (JSON Pointer) ``$ref``
* Deprecations

* ``Validator`` is replaced by ``Draft3Validator`` with a slightly different
 interface
* ``validator(meta_validate=False)``

0.7.0

-----

- Exception tracebacks for several known-cases are printed in a shortened
format. A new option, ``--traceback-mode`` can be used to request long traces,
as in ``--traceback-mode full``
- For schemas which do not include ``$id``, the schema URI will be used for
``$ref`` resolution. This applies to HTTP(S) schema URI as well as to local
paths. Thanks to :user:`dkolepp` for the bug report and contributions!

0.6

====

* Bugfixes

* Issue 30 - Wrong behavior for the dependencies property validation
* Fixed a miswritten test

0.6.0

-----

- Add support for string format verification, by enabling use of the
``jsonschema.FormatChecker``. This is enabled by default, but can be disabled
with the ``--disable-format`` flag

0.5.1

-----

- Improved error output when the schema itself is invalid, either because it is
not JSON or because it does not validate under its relevant metaschema

0.5

====

* Bugfixes

* Issue 17 - require path for error objects
* Issue 18 - multiple type validation for non-objects

0.5.0

-----

- Added the ``--default-filetype`` flag, which sets a default of JSON or YAML
loading to use when ``identify`` does not detect the filetype of an instance
file. Defaults to failure on extensionless files.
- Schemafiles are now passed through ``os.path.expanduser``, meaning that a
schema path of ``~/myschema.json`` will be expanded by check-jsonschema
itself (:issue:`9`)
- Performance enhancement for testing many files: only load the schema once
- Added ``--no-cache`` option to disable schema caching
- Change the default schema download cache directory from
``jsonschema_validate`` to ``check_jsonschema/downloads``.
e.g. ``~/.cache/jsonschema_validate`` is now
``~/.cache/check_jsonschema/downloads``.
Caches will now be in the following locations for different platforms
and environments:

- ``$XDG_CACHE_HOME/check_jsonschema/downloads`` (Linux/other, XDG cache dir)
- ``~/.cache/check_jsonschema/downloads`` (Linux/other, no XDG cache dir set)
- ``~/Library/Caches/check_jsonschema/downloads`` (macOS)
- ``%LOCALAPPDATA%\check_jsonschema\downloads`` (Windows, local app data set)
- ``%APPDATA%\check_jsonschema\downloads`` (Windows, no local app data set, but appdata set)

0.4.1

-----

- Update the azure-pipelines schema version to latest. Thanks to :user:`Borda`

0.4

====

* Preliminary support for programmatic access to error details (Issue 5).
There are certainly some corner cases that don't do the right thing yet, but
this works mostly.

 In order to make this happen (and also to clean things up a bit), a number
 of deprecations are necessary:

     * ``stop_on_error`` is deprecated in ``Validator.__init__``. Use
       ``Validator.iter_errors()`` instead.
     * ``number_types`` and ``string_types`` are deprecated there as well.
       Use ``types={"number" : ..., "string" : ...}`` instead.
     * ``meta_validate`` is also deprecated, and instead is now accepted as
       an argument to ``validate``, ``iter_errors`` and ``is_valid``.

* A bugfix or two

0.4.0

-----

- Fix a bug with parallel runs writing the same file in an unsafe way
- Update the base cache directory on macOS to ``~/Library/Caches/``.
Thanks to :user:`foolioo`

0.3.2

-----

- Bugfix: handle last-modified header being un-set on schema request. Thanks to
:user:`foolioo` for the fix!

0.3.1

-----

- Bugfix: handle non-string elements in the json path. Thanks to
:user:`Jean-MichelBenoit` for the fix!

0.3

====

* Default for unknown types and properties is now to *not* error (consistent
with the schema).
* Python 3 support
* Removed dependency on SecureTypes now that the hash bug has been resolved.
* "Numerous bug fixes" -- most notably, a divisibleBy error for floats and a
bunch of missing typechecks for irrelevant properties.


.. Unlike other docs, the changelog is incorporated into a sphinx doc site in
.. which we want to use sphinx-issues to generate links.
.. As a result, it's maintained as ReST doc, not markdown.

CHANGELOG
=========

Unreleased
----------

.. vendor-insert-here

- Update vendored schemas (2023-07-18)

0.3.0

-----

- Don't show full schemas on errors. Show only the filename, path, and message
- Convert from package to single module layout

0.2.1

-----

- Add hooks for additional CI systems: Azure pipelines, GitHub Actions, and Travis

0.2.0

-----

- Add ``check-github-workflows`` hook

0.1.1

-----

- Set min pre-commit version

0.1.0

-----

- Initial version
Links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant