Merge pull request #90 from cwacek/feature/explain-multiple-objects

feature: Explain how to build multiple top level objects.

Author: cwacek

python_jsonschema_objects/examples/README.md

@@ -174,6 +174,60 @@ schemas are unique.
 }
 ```
 
+## Generating Multiple Top Level Objects
+
+Sometimes what you really want to do is define a couple
+of different objects in a schema, and then be able to use
+them flexibly.
+
+Any object built as a reference can be obtained from the top
+level namespace. Thus, to obtain multiple top level classes,
+define them separately in a definitions structure, then simply
+make the top level schema refer to each of them as a `oneOf`.
+
+The schema and code example below show how this works.
+
+``` schema
+{
+    "title": "MultipleObjects",
+    "id": "foo",
+    "type": "object",
+    "oneOf":[
+            {"$ref": "#/definitions/ErrorResponse"},
+            {"$ref": "#/definitions/VersionGetResponse"}
+            ],
+    "definitions": {
+        "ErrorResponse": {
+            "title": "Error Response",
+            "id": "Error Response",
+            "type": "object",
+            "properties": {
+                "message": {"type": "string"},
+                "status": {"type": "integer"}
+            },
+            "required": ["message", "status"]
+        },
+        "VersionGetResponse": {
+            "title": "Version Get Response",
+            "type": "object",
+            "properties": {
+                "local": {"type": "boolean"},
+                "version": {"type": "string"}
+            },
+            "required": ["version"]
+        }
+    }
+}
+```
+
+``` python
+>>> builder = pjs.ObjectBuilder('multiple_objects.json')
+>>> classes = builder.build_classes()
+>>> print(dir(classes))
+[u'ErrorResponse', 'Local', 'Message', u'Multipleobjects',
+'Status', 'Version', u'VersionGetResponse']
+```
+
 ## Installation
 
     pip install python_jsonschema_objects

test/test_pytest.py

@@ -64,9 +64,8 @@ def test_build_classes_is_idempotent():
         }
     }
     builder = pjs.ObjectBuilder(schema)
+    x = builder.build_classes()
     builder.build_classes()
-    builder.build_classes()
-
 
 
 def test_underscore_properties():

test/test_regression_87.py

@@ -0,0 +1,15 @@
+import pytest
+
+import python_jsonschema_objects as pjs
+
+
+def test_multiple_objects_are_defined(markdown_examples):
+    builder = pjs.ObjectBuilder(
+        markdown_examples['MultipleObjects'],
+        resolved=markdown_examples)
+
+    assert builder
+    classes = builder.build_classes()
+    assert 'ErrorResponse' in classes
+    assert 'VersionGetResponse' in classes
+    print(dir(classes))