Skip to main content

Generate test data from JSON schemata with Hypothesis

Project description

hypothesis-jsonschema

A Hypothesis strategy for generating data that matches some JSON schema.

Here's the PyPI page.

API

The public API consists of just one function: hypothesis_jsonschema.from_schema, which takes a JSON schema and returns a strategy for allowed JSON objects.

from hypothesis import given
from hypothesis_jsonschema import from_schema


@given(from_schema(
    {"type": "integer", "minimum": 1, "exclusiveMaximum": 10}
))
def test_integers(value):
    assert isinstance(value, int)
    assert 1 <= value < 10


@given(from_schema(
    {"type": "string", "format": "card"},
    # Standard formats work out of the box.  Custom formats are ignored
    # by default, but you can pass custom strategies for them - e.g.
    custom_formats={"card": st.sampled_from(EXAMPLE_CARD_NUMBERS)}
))
def test_card_numbers(value):
    assert isinstance(value, str)
    assert re.match(r"^\d{4} \d{4} \d{4} \d{4}$", value)

For more details on property-based testing and how to use or customise strategies, see the Hypothesis docs.

JSONSchema drafts 04, 05, and 07 are fully tested and working. As of version 0.11, this includes resolving non-recursive references!

Supported versions

hypothesis-jsonschema requires Python 3.6 or later. In general, 0.x versions will require very recent versions of all dependencies because I don't want to deal with compatibility workarounds.

hypothesis-jsonschema may make backwards-incompatible changes at any time before version 1.x - that's what semver means! - but I've kept the API surface small enough that this should be avoidable. The main source of breaks will be if or when schema that never really worked turn into explicit errors instead of generating values that don't quite match.

You can sponsor me to get priority support, roadmap input, and prioritized feature development.

Contributing to hypothesis-jsonschema

We love external contributions - and try to make them both easy and fun. You can read more details in our contributing guide, and see everyone who has contributed on GitHub. Thanks, everyone!

Changelog

Patch notes can be found in CHANGELOG.md.

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Project details


Download files

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

Source Distribution

hypothesis-jsonschema-0.17.2.tar.gz (28.7 kB view details)

Uploaded Source

Built Distribution

hypothesis_jsonschema-0.17.2-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

Details for the file hypothesis-jsonschema-0.17.2.tar.gz.

File metadata

  • Download URL: hypothesis-jsonschema-0.17.2.tar.gz
  • Upload date:
  • Size: 28.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for hypothesis-jsonschema-0.17.2.tar.gz
Algorithm Hash digest
SHA256 941c59e7350cda07e82a83fac92f8757bd59c5b3a3dcc2b9b76231737f3c335c
MD5 ae5f32eef7c2fce7f1527f35929562d1
BLAKE2b-256 22e7fe619e5201361a11fa623f4b2a4447be371e4d1e69c4e593bcc5b5fa12c9

See more details on using hashes here.

Provenance

File details

Details for the file hypothesis_jsonschema-0.17.2-py3-none-any.whl.

File metadata

  • Download URL: hypothesis_jsonschema-0.17.2-py3-none-any.whl
  • Upload date:
  • Size: 25.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.3

File hashes

Hashes for hypothesis_jsonschema-0.17.2-py3-none-any.whl
Algorithm Hash digest
SHA256 53e3c33312d842ed9e1de195bbe48656367b277f737e21cb6f400ffdbedc09c4
MD5 80f5d54842e0bfa39dcaad091aa914f1
BLAKE2b-256 6393ab75707afcf9540a48f0093312ce2a8729550ac4f602f5cd032f78a29c96

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page