Skip to main content

An object wrapper for JSON Schema definitions

Project description

python-jsonschema-objects
=========================

What
----

python-jsonschema-objects provides an *automatic* class-based binding to
JSON schemas for use in python.

For example, given the following schema:

.. code:: schema

{
"title": "Example Schema",
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"age": {
"description": "Age in years",
"type": "integer",
"minimum": 0
},
"dogs": {
"type": "array",
"items": {"type": "string"},
"maxItems": 4
}
},
"required": ["firstName", "lastName"]
}

jsonschema-objects can generate a class based binding. Assume here that
the schema above has been loaded in a variable called ``schema``:

.. code:: python

>>> import python_jsonschema_objects as pjs
>>> builder = pjs.ObjectBuilder(schema)
>>> ns = builder.build_classes()
>>> Person = ns.ExampleSchema
>>> james = Person(firstName="James", lastName="Bond")
>>> james.lastName
u'Bond'
>>> james
<example_schema lastName=Bond age=None firstName=James>

Validations will also be applied as the object is manipulated.

.. code:: python

>>> james.age = -2
python_jsonschema_objects.validators.ValidationError: -4 was less
or equal to than 0

The object can be serialized out to JSON:

.. code:: python

>>> james.serialize()
'{"lastName": "Bond", "age": null, "firstName": "James"}'

Why
---

Ever struggled with how to define message formats? Been frustrated by
the difficulty of keeping documentation and message definition in
lockstep? Me too.

There are lots of tools designed to help define JSON object formats,
foremost among them `JSON Schema <http://json-schema.org>`__. JSON
Schema allows you to define JSON object formats, complete with
validations.

However, JSON Schema is language agnostic. It validates encoded JSON
directly - using it still requires an object binding in whatever
language we use. Often writing the binding is just as tedious as writing
the schema itself.

This avoids that problem by auto-generating classes, complete with
validation, directly from an input JSON schema. These classes can
seamlessly encode back and forth to JSON valid according to the schema.

Installation
------------

::

pip install python_jsonschema_objects

Tests
-----

Tests are managed using the excellent Tox. Simply ``pip install tox``,
then ``tox``.

Changelog
---------

0.0.7 - Required properties containing the '@' symbol no longer cause
``build_classes()`` to fail.

0.0.6 - All literals now use a standardized LiteralValue type. Array
validation actually coerces element types. ``as_dict`` can translate
objects to dictionaries seamlessly.

0.0.5 - Improved validation for additionalItems (and tests to match).
Provided dictionary-syntax access to object properties and iteration
over properties.

0.0.4 - Fixed some bugs that only showed up under specific schema
layouts, including one which forced remote lookups for schema-local
references.

0.0.3b - Fixed ReStructuredText generation

0.0.3 - Added support for other array validations (minItems, maxItems,
uniqueItems).

0.0.2 - Array item type validation now works. Specifying 'items', will
now enforce types, both in the tuple and list syntaxes.

0.0.1 - Class generation works, including 'oneOf' and 'allOf'
relationships. All basic validations work.

Project details


Release history Release notifications

History Node

0.3.2

History Node

0.3.1

History Node

0.3.0

History Node

0.2.4

History Node

0.2.3

History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.1.post1

History Node

0.1.1

History Node

0.1.0

History Node

0.0.23.post1

History Node

0.0.23

History Node

0.0.22.post1

History Node

0.0.22

History Node

0.0.21

History Node

0.0.20.post1

History Node

0.0.20

History Node

0.0.19.post2

History Node

0.0.19

History Node

0.0.18.post3

History Node

0.0.18.post2

History Node

0.0.18.post1

History Node

0.0.18

History Node

0.0.17.post2

History Node

0.0.17.post1

History Node

0.0.16

History Node

0.0.15

History Node

0.0.14

History Node

0.0.13

History Node

0.0.12

History Node

0.0.11

History Node

0.0.10.post2

History Node

0.0.10.post1

History Node

0.0.10

History Node

0.0.9

History Node

0.0.8

This version
History Node

0.0.7

History Node

0.0.6

History Node

0.0.5

History Node

0.0.4

History Node

0.0.3

History Node

0.0.3b

History Node

0.0.2

History Node

0.0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
python_jsonschema_objects-0.0.7-py2.py3-none-any.whl (19.7 kB) Copy SHA256 hash SHA256 Wheel 2.7 Jun 5, 2014
python_jsonschema_objects-0.0.7.tar.gz (15.9 kB) Copy SHA256 hash SHA256 Source None Jun 5, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page