Skip to main content

JSON Data Definition Format support for Python

Project description

jddf-python PyPI version

Documentation on

This package is a Python implementation of JSON Data Definition Format, a schema language for JSON.


Install this package using:

pip3 install jddf


Briefly, here's how you would use this package:

import Schema, Validator from jddf
import json

# jddf.Schema represents a JDDF Schema.
# You can parse a jddf.Schema from JSON using Schema.from_json in combination
# with the standard library's json module.
schema = Schema.from_json(json.loads("""
    "properties": {
      "name": { "type": "string" },
      "age": { "type": "uint32" },
      "phones": {
        "elements": { "type": "string" }

# jddf.Validator validates inputted data against schemas, and returns a list of
# validation errors.
# The exact data in validation errors is part of the JDDF specification, so
# every implementation of JDDF, across all languages, return the same sort of
# validation errors.
validator = Validator()

# This input is ok -- it passes all of the rules of the schema. So no validation
# errors are returned.
errors_ok = validator.validate(schema, json.loads("""
    "name": "John Doe",
    "age": 43,
    "phones": ["+44 1234567", "+44 2345678"]

print(errors_ok) # []

# This input has three problems, so three validation errors are returned.
errors_bad = validator.validate(schema, json.loads("""
    "age": "43",
    "phones": ["+44 1234567", 442345678]

print(len(errors_bad)) # 3

# "name" is required
# [{'instance_path': [], 'schema_path': ['properties', 'name']}]

# "age" has wrong type
# [{'instance_path': ['age'], 'schema_path': ['properties', 'age', 'type']}]

# "phones[1]" has wrong type
# [{'instance_path': ['phones', '1'], 'schema_path': ['properties', 'phones', 'elements', 'type']}]

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

jddf-0.1.2.tar.gz (8.3 kB view hashes)

Uploaded source

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