Skip to main content

Strictly checks that a json schema is valid

Project description

perfect-jsonschema

Build Status codecov

Because soft validation is not enough

Why

JSON schema standard and its implementations stand that if you have something unfamiliar in your schema, it's not an error. In particular, you won't get an error if you made a typo or used something you thought as working. For example, this one is perfectly fine and valid:

{
    "required": ["company"],
    "type": "object",
    "propertie": {"company": {"pattern": "^(Apple)$"}, "format": "url"},
}

But we want to catch those propertie typos and invalid url formats.

The library rely on jsonschema and supports additional keywords to ignore.

Features

Derives the draft from the schema and yields a jsonschema.SchemaError if:

  • A schema is empty
  • A schema contains a keyword which is not a part of a jsonschema implementation or extended_keywords set
  • A schema contains an invalid format value
  • A schema fails with jsonschema.check_schema()

Usage

from perfect-jsonschema import check

try:
    check(schema, extended_keywords={"tag"})
except Exception as e:
    do_something()

An exception example:

Traceback (most recent call last):
    f"Schema contains invalid keywords for "
jsonschema.exceptions.SchemaError: Schema contains invalid keywords for http://json-schema.org/draft-07/schema#:
{'propertie', 'company'}

Local development

pipenv install --dev
pipenv shell
tox

Contribution

Any contribution is welcome

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for perfect-jsonschema, version 2019.2.6
Filename, size File type Python version Upload date Hashes
Filename, size perfect_jsonschema-2019.2.6-py3-none-any.whl (4.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size perfect-jsonschema-2019.2.6.tar.gz (11.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page