Generate test data from JSON schemata with Hypothesis
Project description
hypothesis-jsonschema
A Hypothesis strategy for generating data that matches some JSON schema.
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.
Schema reuse with "definitions" and "$ref" is not yet supported, but everything else in drafts 04, 05, and 07 is fully tested and working.
For details on how to use this strategy in your tests, see the Hypothesis docs.
Supported versions
hypothesis-jsonschema does not support Python 2, because
it's close to end of life and Python 3.6+ is a
much nicer language. Contact me if you would like this changed and are
willing to either pay for or do the work to support Python 2.
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.
Professional support for Hypothesis and hypothesis-jsonschema is available as part of the Tidelift Subscription. Tidelift gives software development teams a single source for purchasing and maintaining their software, with professional grade assurances from the experts who know it best.
Changelog:
0.9.8 - 2019-08-24
- Corrected handling of the
"format"keyword with unknown values - custom values are allowed by the spec and should be treated as annotations (i.e. ignored).
0.9.7 - 2019-08-15
- Improved canonicalisation, especially for deeply nested schemas.
0.9.6 - 2019-08-02
- A performance optimisation for null and boolean schema,
which relies on a bugfix in
jsonschema >= 3.0.2.
0.9.5 - 2019-08-02
- Improved handling of the
containskeyword for arrays
0.9.4 - 2019-07-01
- Improved canonicalisation and merging for a wide range of schemas, which as usual unlocks significant optimisations and performance improvements for cases where they apply.
0.9.3 - 2019-06-13
- Future-proofed canonicalisation of
typekey.
0.9.2 - 2019-05-23
- Better internal canonicalization, which makes current and future optimisations more widely applicable.
- Yet another fix, this time for negative zero and numeric bouds as floats with sub-integer precision. IEEE 754 is tricky, even with Hypothesis!
- Fixes handling of
enumwith elements disallowed by base schema, handling ofif-then-elsewith a base schema, and handling of regex patterns that are invalid in Python.
0.9.1 - 2019-05-22
- Fix the fix for numeric schemas with
multipleOfand exclusive bounds.
0.9.0 - 2019-05-21
- Supports merging schemas for overlapping
patternProperties, a significant performance improvement in most cases. - If the
"type"key is missing, it is now inferred from other keys rather than always defaulting to"object". - Fixed handling of complicated numeric bounds.
0.8.2 - 2019-05-21
- Improve performance for object schemas where the min and max size can be
further constrained from
propertiesandpropertyNamesattributes.
0.8.1 - 2019-03-24
- Supports draft-04 schemata with the latest version of
jsonschema
0.8.0 - 2019-03-23
- Further improved support for
allOf,oneOf, andanyOfwith base schemata - Added support for
dependencies - Handles overlapping
patternProperties
0.7.0 - 2019-03-21
- Now requires
jsonschema>= 3.0 - Improved support for
allOf,oneOf, andpropertyNames - Supports schemata with
"type": [an array of types] - Warning-free on Hypothesis 4.11
0.6.1 - 2019-02-23
- Fix continuous delivery configuration (before the latent bug manifested)
0.6.0 - 2019-02-23
- Support for conditional subschemata, i.e. the
if,then,elsekeywords, and theanyOf,allOf,oneOf, andnotkeywords.
0.5.0 - 2019-02-22
- Works with
jsonschema3.0 pre-release - Initial support for draft06 and draft07
0.4.2 - 2019-02-14
- Dropped dependency on
canonicaljson - Less warnings on Python 3.7
0.4.1 - 2019-02-06
- Relicensed under the more permissive Mozilla Public License, like Hypothesis
- Requires Hypothesis version 4.0 or later
- Fixed an array bounds bug with
maxItemsandcontainskeywords
0.4.0 - 2018-11-25
Supports string formats (email, datetime, etc) and simple use of the
"contains" keyword for arrays.
0.3.0 - 2018-11-25
Good support for all basic types. MVP.
0.2.0 - 2018-11-24
Inference for null, boolean, string, and numeric types.
0.1.0 - 2018-11-21
Stake in the ground (generate arbitrary JSON and filter it!)
Security contact information
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hypothesis-jsonschema-0.9.8.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8bc9097762c29ead5bd075b2d773fbc4c3911c564be25af32d1fa646490a55b0 |
|
| MD5 | 643cd55ec5c16c9b353caccb417e1c0d |
|
| BLAKE2b-256 | aabc8bc291962a71c7f26be05944abef58729507e91ffc81dfb4e20feadf751c |
Hashes for hypothesis_jsonschema-0.9.8-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 01d4f5a03c3a577b4b57c9c736d94489727826ed6c1f8447fc4b1546b84b6f75 |
|
| MD5 | cc27c0ff53fc1a3c68e2c92f8f330cb3 |
|
| BLAKE2b-256 | 19d0c7e6eae3df059da61524175fcb8a45532fbfe9a5c3e8ae776974543862f3 |
