Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

validator for JSON/YAML/dict data

Project description

dictspec is a simple Python library that validates dictionary and list based data structures. You can use it to validate JSON/YAML documents against your own specification.

It is MIT licensed and uses relative imports, so you can just drop it into your project.

Examples

Validate against plain Python data objects or types:

>>> spec = {
...   'foo': 1,
...   'bar': [basestring],
... }
>>> data = {
...   'foo': 4,
...   'bar': ['hello', u'w\x00F6rld']}
... }
>>> from dictspec.validator import validate
>>> validate(spec, data)

Use more complex specs and get detailed errors:

>>> from dictspec.spec import number, required
>>> spec = {
...   required('foo'): number(),
...   'bar': bool(),
... }
>>> data = {
...                 # missing 'foo' key
...   'bar': 4,     # wrong type
...   'baz': True,  # unknown key
... }
>>> from dictspec.validator import ValidationError
>>> try:
...   validate(spec, data)
... except ValidationError, ex:
...   print ex.errors
["missing 'foo' not in .", "unknown 'baz' in .", '4 in bar not of type bool']

Also with recursion and arbitrary keys:

>>> from dictspec.spec import anything, recursive
>>> spec = {
...   'hello': recursive({
...     anything(): recursive(),
...   })
... }
>>> data = {
...   'hello': {'any': {'thing': {'recursive':{}}}}
... }
>>> validate(spec, data)

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 dictspec, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size dictspec-0.2.1.tar.gz (6.3 kB) File type Source Python version None Upload date Hashes View

Supported by

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