Adding the ability to set a 'required' boolean kwarg in the Object.add_object method

AUTHORS.rst

@@ -12,3 +12,4 @@ Contributors
 - `Heiho1 <https://github.com/heiho1>`_
 - `YehudaCorsia <https://github.com/YehudaCorsia>`_
 - `KOLANICH <https://github.com/KOLANICH>`_
+- `Shane Curtin <https://github.com/sj-curtin>`_

README.rst

@@ -153,12 +153,13 @@ Merge in a JSON schema. This can be a ``dict`` or another ``SchemaBuilder`` obje
     There is no schema validation. If you pass in a bad schema,
     you might get back a bad schema.
 
-``add_object(obj)``
-^^^^^^^^^^^^^^^^^^^
+``add_object(obj, **kwargs)``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Modify the schema to accommodate an object.
 
 :param obj: any object or scalar that can be serialized in JSON
+:param \**required (bool): if set to `False` the required keyword in the schema will not be included
 
 ``to_schema()``
 ^^^^^^^^^^^^^^^

genson/schema/builder.py

@@ -83,13 +83,13 @@ def add_schema(self, schema):
             del schema['$schema']
         self._root_node.add_schema(schema)
 
-    def add_object(self, obj):
+    def add_object(self, obj, **kwargs):
         """
         Modify the schema to accommodate an object.
 
         :param obj: any object or scalar that can be serialized in JSON
         """
-        self._root_node.add_object(obj)
+        self._root_node.add_object(obj, **kwargs)
 
     def to_schema(self):
         """

genson/schema/node.py

@@ -36,7 +36,7 @@ def add_schema(self, schema):
         # return self for easy method chaining
         return self
 
-    def add_object(self, obj):
+    def add_object(self, obj, **kwargs):
         """
         Modify the schema to accommodate an object.
 
@@ -47,7 +47,7 @@ def add_object(self, obj):
 
         # delegate to SchemaType object
         active_strategy = self._get_strategy_for_object(obj)
-        active_strategy.add_object(obj)
+        active_strategy.add_object(obj, **kwargs)
 
         # return self for easy method chaining
         return self

genson/schema/strategies/array.py

@@ -38,9 +38,9 @@ def add_schema(self, schema):
         if 'items' in schema:
             self._items.add_schema(schema['items'])
 
-    def add_object(self, obj):
+    def add_object(self, obj, **kwargs):
         for item in obj:
-            self._items.add_object(item)
+            self._items.add_object(item, **kwargs)
 
     def items_to_schema(self):
         return self._items.to_schema()

genson/schema/strategies/base.py

@@ -43,7 +43,7 @@ def _add_extra_keywords(self, schema):
                       'values ({1!r} vs. {2!r}). Using {1!r}').format(
                           keyword, self._extra_keywords[keyword], value))
 
-    def add_object(self, obj):
+    def add_object(self, obj, **kwargs):
         pass
 
     def to_schema(self):

genson/schema/strategies/object.py

@@ -46,7 +46,7 @@ def add_schema(self, schema):
             else:
                 self._required &= required
 
-    def add_object(self, obj):
+    def add_object(self, obj, **kwargs):
         properties = set()
         for prop, subobj in obj.items():
             pattern = None
@@ -55,12 +55,15 @@ def add_object(self, obj):
                 pattern = self._matching_pattern(prop)
 
             if pattern is not None:
-                self._pattern_properties[pattern].add_object(subobj)
+                self._pattern_properties[pattern].add_object(subobj, **kwargs)
             else:
                 properties.add(prop)
-                self._properties[prop].add_object(subobj)
+                self._properties[prop].add_object(subobj, **kwargs)
 
-        if self._required is None:
+        # If 'required' is set to False they will not be added to the schema
+        if kwargs.get("required") is False:
+            self._required = set()
+        elif self._required is None:
             self._required = properties
         else:
             self._required &= properties

genson/schema/strategies/scalar.py

@@ -68,7 +68,7 @@ def add_schema(self, schema):
         if schema.get('type') == 'number':
             self._type = 'number'
 
-    def add_object(self, obj):
+    def add_object(self, obj, **kwargs):
         if isinstance(obj, float):
             self._type = 'number'
 

test/base.py

@@ -16,8 +16,8 @@ def setUp(self):
     def set_schema_options(self, **options):
         self.builder = SchemaNode(**options)
 
-    def add_object(self, obj):
-        self.builder.add_object(obj)
+    def add_object(self, obj, **kwargs):
+        self.builder.add_object(obj, **kwargs)
         self._objects.append(obj)
 
     def add_schema(self, schema):

test/test_builder.py

@@ -28,6 +28,39 @@ def test_add_object(self):
             "$schema": SchemaBuilder.DEFAULT_URI,
             "type": "null"})
 
+    def test_add_object_required_false(self):
+        mock_dict = {
+            "mock_value_one": "abc"
+        }
+        self.add_object(mock_dict, required=False)
+
+        self.assertResult({
+            "$schema": SchemaBuilder.DEFAULT_URI,
+            "type": "object",
+            "properties": {
+                "mock_value_one": {
+                    "type": "string"
+                }
+            }
+        })
+
+    def test_add_object_required_true(self):
+        mock_dict = {
+            "mock_value_one": "abc"
+        }
+        self.add_object(mock_dict, required=True)
+
+        self.assertResult({
+            "$schema": SchemaBuilder.DEFAULT_URI,
+            "type": "object",
+            "properties": {
+                "mock_value_one": {
+                    "type": "string"
+                }
+            },
+            "required": ["mock_value_one"]
+        })
+
     def test_to_json(self):
         self.assertEqual(
             self.builder.to_json(),