[Python-experimental] JSON schema 'null' type should be modeled as 'none_type'

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenProperty.java

@@ -134,7 +134,9 @@ public class CodegenProperty implements Cloneable, IJsonSchemaValidationProperti
     public boolean isUri;
     public boolean isEmail;
     /**
-     * The type is a free-form object, i.e. it is a map of string to values with no declared properties
+     * The type is a free-form object, i.e. it is a map of string to values with no declared properties.
+     * A OAS free-form schema may include the 'additionalProperties' attribute, which puts a constraint
+     * on the type of the undeclared properties.
      */
     public boolean isFreeFormObject;
     /**
@@ -153,6 +155,9 @@ public class CodegenProperty implements Cloneable, IJsonSchemaValidationProperti
     public boolean isDiscriminator;
     public List<String> _enum;
     public Map<String, Object> allowableValues;
+    // If 'additionalProperties' is not set, items is null.
+    // If 'additionalProperties' is set to a type or refers to a type, 'items' provides the type information for
+    // the undeclared properties. 
     public CodegenProperty items;
     public CodegenProperty mostInnerItems;
     public Map<String, Object> vendorExtensions = new HashMap<String, Object>();

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

@@ -2180,7 +2180,14 @@ public CodegenModel fromModel(String name, Schema schema) {
             m.xmlNamespace = schema.getXml().getNamespace();
             m.xmlName = schema.getXml().getName();
         }
-
+        if (ModelUtils.isAnyTypeSchema(schema)) {
+            // The 'null' value is allowed when the OAS schema is 'any type'.
+            // See https://github.com/OAI/OpenAPI-Specification/issues/1389
+            if (Boolean.FALSE.equals(schema.getNullable())) {
+                LOGGER.error("Schema '{}' is any type, which includes the 'null' value. 'nullable' cannot be set to 'false'", name);
+            }
+            m.isNullable = true;
+        }
         if (ModelUtils.isArraySchema(schema)) {
             m.isArrayModel = true;
             m.arrayModelType = fromProperty(name, schema).complexType;
@@ -3003,6 +3010,12 @@ public CodegenProperty fromProperty(String name, Schema p) {
         } else if (ModelUtils.isFreeFormObject(p)) {
             property.isFreeFormObject = true;
         } else if (ModelUtils.isAnyTypeSchema(p)) {
+            // The 'null' value is allowed when the OAS schema is 'any type'.
+            // See https://github.com/OAI/OpenAPI-Specification/issues/1389
+            if (Boolean.FALSE.equals(p.getNullable())) {
+                LOGGER.warn("Schema '{}' is any type, which includes the 'null' value. 'nullable' cannot be set to 'false'", p.getName());
+            }
+            property.isNullable = true;
             property.isAnyType = true;
         } else if (ModelUtils.isArraySchema(p)) {
             // default to string if inner item is undefined

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonClientCodegen.java

@@ -143,6 +143,7 @@ public PythonClientCodegen() {
         // map uuid to string for the time being
         typeMapping.put("UUID", "str");
         typeMapping.put("URI", "str");
+        typeMapping.put("null", "none_type");
 
         // from https://docs.python.org/3/reference/lexical_analysis.html#keywords
         setReservedWordsLowerCase(

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonClientExperimentalCodegen.java

@@ -388,7 +388,9 @@ public Map<String, Object> postProcessAllModels(Map<String, Object> objs) {
                 composedSchemaSets.add(cm.oneOf);
                 for (Set<String> importSet : composedSchemaSets) {
                     for (String otherModelName : importSet) {
-                        cm.imports.add(otherModelName);
+                        if (!languageSpecificPrimitives.contains(otherModelName)) {
+                            cm.imports.add(otherModelName);
+                        }
                     }
                 }
 

modules/openapi-generator/src/main/java/org/openapitools/codegen/utils/OneOfImplementorAdditionalData.java

@@ -75,9 +75,11 @@ public void addFromInterfaceModel(CodegenModel cm, List<Map<String, String>> mod
         // note that we can't just toAdd.removeAll(m.vars) for every interfaceModel,
         // as they might have different value of `hasMore` and thus are not equal
         List<String> omitAdding = new ArrayList<String>();
-        for (CodegenModel m : cm.interfaceModels) {
-            for (CodegenProperty v : m.vars) {
-                omitAdding.add(v.baseName);
+        if (cm.interfaceModels != null) {
+            for (CodegenModel m : cm.interfaceModels) {
+                for (CodegenProperty v : m.vars) {
+                    omitAdding.add(v.baseName);
+                }
             }
         }
         for (CodegenProperty v : toAdd) {

modules/openapi-generator/src/main/resources/python/python-experimental/model_utils.mustache

@@ -64,6 +64,10 @@ class OpenApiModel(object):
         # this function uses the discriminator to
         # pick a new schema/class to instantiate because a discriminator
         # propertyName value was passed in
+        oneof_anyof_classes = cls._composed_schemas.get('oneOf', ()) +
+                                cls._composed_schemas.get('anyOf', ())
+        if oneof_anyof_classes and none_type in oneof_anyof_classes and args[0] is None:
+            return None
 
         visited_composed_classes = kwargs.get('_visited_composed_classes', ())
         if (
@@ -75,9 +79,6 @@ class OpenApiModel(object):
             # want to instantiate it this time
             return super(OpenApiModel, cls).__new__(cls)
 
-        oneof_anyof_classes = []
-        oneof_anyof_classes.extend(cls._composed_schemas.get('oneOf', ()))
-        oneof_anyof_classes.extend(cls._composed_schemas.get('anyOf', ()))
         new_cls = cls.get_discriminator_class(kwargs)
         if new_cls is None:
             disc_prop_name_py = list(cls.discriminator.keys())[0]
@@ -1032,7 +1033,7 @@ def get_oneof_instance(self, model_args, constant_args):
             and path to item.
 
     Returns
-        oneof_instance (instance/None)
+        oneof_instance (instance)
     """
     if len(self._composed_schemas['oneOf']) == 0:
         return None
@@ -1086,9 +1087,11 @@ def get_anyof_instances(self, model_args, constant_args):
     Args:
         self: the class we are handling
         model_args (dict): var_name to var_value
-            used to make instances
+            The input data, e.g. the payload that must match at least one
+            anyOf child schema in the OpenAPI document.
         constant_args (dict): var_name to var_value
-            used to make instances
+            args that every model requires, including configuration, server
+            and path to item.
 
     Returns
         anyof_instances (list)

modules/openapi-generator/src/test/resources/3_0/python-experimental/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml

@@ -1250,22 +1250,32 @@ components:
           type: integer
           format: int32
           description: User Status
-        arbitraryObject:
+        objectWithNoDeclaredProps:
           type: object
           description: test code generation for objects
             Value must be a map of strings to values. It cannot be the 'null' value.
-        arbitraryNullableObject:
+        objectWithNoDeclaredPropsNullable:
           type: object
           description: test code generation for nullable objects.
             Value must be a map of strings to values or the 'null' value.
           nullable: true
-        arbitraryTypeValue:
+        anyTypeProp:
           description: test code generation for any type
-            Value can be any type - string, number, boolean, array or object.
-        arbitraryNullableTypeValue:
+            Here the 'type' attribute is not specified, which means the value can be anything,
+            including the null value, string, number, boolean, array or object.
+            See https://github.com/OAI/OpenAPI-Specification/issues/1389
+        # TODO: this should be supported, currently there are some issues in the code generation.
+        #anyTypeExceptNullProp:
+        #  description: any type except 'null'
+        #    Here the 'type' attribute is not specified, which means the value can be anything,
+        #    including the null value, string, number, boolean, array or object.
+        #  not:
+        #    type: 'null'
+        anyTypePropNullable:
           description: test code generation for any type
-            Value can be any type - string, number, boolean, array, object or
-            the 'null' value.
+            Here the 'type' attribute is not specified, which means the value can be anything,
+            including the null value, string, number, boolean, array or object.
+            The 'nullable' attribute does not change the allowed values.
           nullable: true
       xml:
         name: User
@@ -1855,6 +1865,7 @@ components:
           - $ref: '#/components/schemas/banana'
     fruitReq:
        oneOf:
+          - type: 'null'
           - $ref: '#/components/schemas/appleReq'
           - $ref: '#/components/schemas/bananaReq'
     appleReq:

samples/client/petstore/python-experimental/petstore_api/model_utils.py

@@ -134,6 +134,10 @@ def __new__(cls, *args, **kwargs):
         # this function uses the discriminator to
         # pick a new schema/class to instantiate because a discriminator
         # propertyName value was passed in
+        oneof_anyof_classes = cls._composed_schemas.get('oneOf', ()) +
+                                cls._composed_schemas.get('anyOf', ())
+        if oneof_anyof_classes and none_type in oneof_anyof_classes and args[0] is None:
+            return None
 
         visited_composed_classes = kwargs.get('_visited_composed_classes', ())
         if (
@@ -145,9 +149,6 @@ def __new__(cls, *args, **kwargs):
             # want to instantiate it this time
             return super(OpenApiModel, cls).__new__(cls)
 
-        oneof_anyof_classes = []
-        oneof_anyof_classes.extend(cls._composed_schemas.get('oneOf', ()))
-        oneof_anyof_classes.extend(cls._composed_schemas.get('anyOf', ()))
         new_cls = cls.get_discriminator_class(kwargs)
         if new_cls is None:
             disc_prop_name_py = list(cls.discriminator.keys())[0]
@@ -1293,7 +1294,7 @@ def get_oneof_instance(self, model_args, constant_args):
             and path to item.
 
     Returns
-        oneof_instance (instance/None)
+        oneof_instance (instance)
     """
     if len(self._composed_schemas['oneOf']) == 0:
         return None
@@ -1347,9 +1348,11 @@ def get_anyof_instances(self, model_args, constant_args):
     Args:
         self: the class we are handling
         model_args (dict): var_name to var_value
-            used to make instances
+            The input data, e.g. the payload that must match at least one
+            anyOf child schema in the OpenAPI document.
         constant_args (dict): var_name to var_value
-            used to make instances
+            args that every model requires, including configuration, server
+            and path to item.
 
     Returns
         anyof_instances (list)

samples/openapi3/client/petstore/go-experimental/go-petstore/docs/User.md

@@ -321,6 +321,16 @@ SetArbitraryTypeValue sets ArbitraryTypeValue field to given value.
 
 HasArbitraryTypeValue returns a boolean if a field has been set.
 
+### SetArbitraryTypeValueNil
+
+`func (o *User) SetArbitraryTypeValueNil(b bool)`
+
+ SetArbitraryTypeValueNil sets the value for ArbitraryTypeValue to be an explicit nil
+
+### UnsetArbitraryTypeValue
+`func (o *User) UnsetArbitraryTypeValue()`
+
+UnsetArbitraryTypeValue ensures that no value is present for ArbitraryTypeValue, not even an explicit nil
 ### GetArbitraryNullableTypeValue
 
 `func (o *User) GetArbitraryNullableTypeValue() interface{}`

samples/openapi3/client/petstore/go-experimental/go-petstore/model_user.go

@@ -29,7 +29,7 @@ type User struct {
 	// test code generation for nullable objects. Value must be a map of strings to values or the 'null' value.
 	ArbitraryNullableObject map[string]interface{} `json:"arbitraryNullableObject,omitempty"`
 	// test code generation for any type Value can be any type - string, number, boolean, array or object.
-	ArbitraryTypeValue *interface{} `json:"arbitraryTypeValue,omitempty"`
+	ArbitraryTypeValue interface{} `json:"arbitraryTypeValue,omitempty"`
 	// test code generation for any type Value can be any type - string, number, boolean, array, object or the 'null' value.
 	ArbitraryNullableTypeValue interface{} `json:"arbitraryNullableTypeValue,omitempty"`
 }
@@ -372,22 +372,23 @@ func (o *User) SetArbitraryNullableObject(v map[string]interface{}) {
 	o.ArbitraryNullableObject = v
 }
 
-// GetArbitraryTypeValue returns the ArbitraryTypeValue field value if set, zero value otherwise.
+// GetArbitraryTypeValue returns the ArbitraryTypeValue field value if set, zero value otherwise (both if not set or set to explicit null).
 func (o *User) GetArbitraryTypeValue() interface{} {
-	if o == nil || o.ArbitraryTypeValue == nil {
+	if o == nil  {
 		var ret interface{}
 		return ret
 	}
-	return *o.ArbitraryTypeValue
+	return o.ArbitraryTypeValue
 }
 
 // GetArbitraryTypeValueOk returns a tuple with the ArbitraryTypeValue field value if set, nil otherwise
 // and a boolean to check if the value has been set.
+// NOTE: If the value is an explicit nil, `nil, true` will be returned
 func (o *User) GetArbitraryTypeValueOk() (*interface{}, bool) {
 	if o == nil || o.ArbitraryTypeValue == nil {
 		return nil, false
 	}
-	return o.ArbitraryTypeValue, true
+	return &o.ArbitraryTypeValue, true
 }
 
 // HasArbitraryTypeValue returns a boolean if a field has been set.
@@ -401,7 +402,7 @@ func (o *User) HasArbitraryTypeValue() bool {
 
 // SetArbitraryTypeValue gets a reference to the given interface{} and assigns it to the ArbitraryTypeValue field.
 func (o *User) SetArbitraryTypeValue(v interface{}) {
-	o.ArbitraryTypeValue = &v
+	o.ArbitraryTypeValue = v
 }
 
 // GetArbitraryNullableTypeValue returns the ArbitraryNullableTypeValue field value if set, zero value otherwise (both if not set or set to explicit null).

samples/openapi3/client/petstore/python-experimental/petstore_api/model_utils.py

@@ -134,6 +134,10 @@ def __new__(cls, *args, **kwargs):
         # this function uses the discriminator to
         # pick a new schema/class to instantiate because a discriminator
         # propertyName value was passed in
+        oneof_anyof_classes = cls._composed_schemas.get('oneOf', ()) +
+                                cls._composed_schemas.get('anyOf', ())
+        if oneof_anyof_classes and none_type in oneof_anyof_classes and args[0] is None:
+            return None
 
         visited_composed_classes = kwargs.get('_visited_composed_classes', ())
         if (
@@ -145,9 +149,6 @@ def __new__(cls, *args, **kwargs):
             # want to instantiate it this time
             return super(OpenApiModel, cls).__new__(cls)
 
-        oneof_anyof_classes = []
-        oneof_anyof_classes.extend(cls._composed_schemas.get('oneOf', ()))
-        oneof_anyof_classes.extend(cls._composed_schemas.get('anyOf', ()))
         new_cls = cls.get_discriminator_class(kwargs)
         if new_cls is None:
             disc_prop_name_py = list(cls.discriminator.keys())[0]
@@ -1293,7 +1294,7 @@ def get_oneof_instance(self, model_args, constant_args):
             and path to item.
 
     Returns
-        oneof_instance (instance/None)
+        oneof_instance (instance)
     """
     if len(self._composed_schemas['oneOf']) == 0:
         return None
@@ -1347,9 +1348,11 @@ def get_anyof_instances(self, model_args, constant_args):
     Args:
         self: the class we are handling
         model_args (dict): var_name to var_value
-            used to make instances
+            The input data, e.g. the payload that must match at least one
+            anyOf child schema in the OpenAPI document.
         constant_args (dict): var_name to var_value
-            used to make instances
+            args that every model requires, including configuration, server
+            and path to item.
 
     Returns
         anyof_instances (list)

samples/openapi3/client/petstore/python-experimental/petstore_api/models/fruit_req.py

@@ -218,5 +218,6 @@ def _composed_schemas():
           'oneOf': [
               apple_req.AppleReq,
               banana_req.BananaReq,
+              none_type,
           ],
         }

samples/openapi3/client/petstore/python-experimental/test/test_fruit_req.py

@@ -70,6 +70,7 @@ def testFruitReq(self):
                 'oneOf': [
                     petstore_api.AppleReq,
                     petstore_api.BananaReq,
+                    type(None),
                 ],
             }
         )

samples/openapi3/client/petstore/python-experimental/tests/test_deserialization.py

@@ -125,4 +125,16 @@ def test_deserialize_mammal(self):
         deserialized = self.deserialize(response, (petstore_api.Mammal,), True)
         self.assertTrue(isinstance(deserialized, petstore_api.Zebra))
         self.assertEqual(deserialized.type, zebra_type)
-        self.assertEqual(deserialized.class_name, class_name)
+        self.assertEqual(deserialized.class_name, class_name)
+
+    def test_deserialize_fruit(self):
+        """
+        deserialize fruit
+        fruitReq is a oneOf composed schema model with discriminator, including 'null' type.
+        """
+
+        # Unmarshal 'null' value
+        data = None
+        response = MockResponse(data=json.dumps(data))
+        deserialized = self.deserialize(response, (petstore_api.FruitReq, type(None)), True)
+        self.assertEqual(type(deserialized), type(None))