[python-experimental] Support schema property which has $ref to 'oneOf' schema and child schema is null type

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

@@ -872,6 +872,32 @@ def attempt_convert_item(input_value, valid_classes, path_to_item,
     return input_value
 
 
+def is_type_nullable(input_type):
+    """
+    Returns true if None is an allowed value for the specified input_type.
+
+    A type is nullable if at least one of the following conditions is true:
+    1. The OAS 'nullable' attribute has been specified,
+    1. The type is the 'null' type,
+    1. The type is a anyOf/oneOf composed schema, and a child schema is
+       the 'null' type.
+    Args:
+        input_type (type): the class of the input_value that we are
+            checking
+    Returns:
+        bool
+    """
+    if input_type is none_type:
+        return True
+    if issubclass(input_type, ModelComposed):
+        # If oneOf/anyOf, check if the 'null' type is one of the allowed types.            
+        for t in input_type._composed_schemas.get('oneOf', ()):
+            if is_type_nullable(t): return True
+        for t in input_type._composed_schemas.get('anyOf', ()):
+            if is_type_nullable(t): return True
+    return False
+
+
 def is_valid_type(input_class_simple, valid_classes):
     """
     Args:
@@ -883,9 +909,14 @@ def is_valid_type(input_class_simple, valid_classes):
         bool
     """
     valid_type = input_class_simple in valid_classes
-    if not valid_type and issubclass(input_class_simple, OpenApiModel):
+    if not valid_type and (
+            issubclass(input_class_simple, OpenApiModel) or
+            input_class_simple is none_type):
         for valid_class in valid_classes:
-            if not valid_class.discriminator:
+            if input_class_simple is none_type and is_type_nullable(valid_class):
+                # Schema is oneOf/anyOf and the 'null' type is one of the allowed types.            
+                return True
+            if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator):
                 continue
             discr_propertyname_py = list(valid_class.discriminator.keys())[0]
             discriminator_classes = (

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

@@ -1897,8 +1897,19 @@ components:
       properties:
         mainShape:
           # A property whose value is a 'oneOf' type, and the type is referenced instead
-          # of being define inline.
+          # of being defined inline. The value cannot be null.
           $ref: '#/components/schemas/Shape'
+        shapeOrNull:
+          # A property whose value is a 'oneOf' type, and the type is referenced instead
+          # of being defined inline. The value may be null because ShapeOrNull has 'null'
+          # type as a child schema of 'oneOf'.
+          $ref: '#/components/schemas/ShapeOrNull'
+        nullableShape:
+          # A property whose value is a 'oneOf' type, and the type is referenced instead
+          # of being defined inline. The value may be null because NullableShape has the
+          # 'nullable: true' attribute. For this specific scenario this is exactly the
+          # same thing as 'shapeOrNull'.
+          $ref: '#/components/schemas/NullableShape'
         shapes:
           type: array
           items:
@@ -1909,6 +1920,25 @@ components:
         - $ref: '#/components/schemas/Quadrilateral'
       discriminator:
         propertyName: shapeType
+    ShapeOrNull:
+      description: The value may be a shape or the 'null' value.
+        This is introduced in OAS schema >= 3.1.
+      oneOf:
+        - type: 'null'
+        - $ref: '#/components/schemas/Triangle'
+        - $ref: '#/components/schemas/Quadrilateral'
+      discriminator:
+        propertyName: shapeType
+    NullableShape:
+      description: The value may be a shape or the 'null' value.
+        The 'nullable' attribute was introduced in OAS schema >= 3.0
+        and has been deprecated in OAS schema >= 3.1.
+      oneOf:
+        - $ref: '#/components/schemas/Triangle'
+        - $ref: '#/components/schemas/Quadrilateral'
+      discriminator:
+        propertyName: shapeType
+      nullable: true
     ShapeInterface:
       properties:
         shapeType:

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

@@ -1138,6 +1138,32 @@ def attempt_convert_item(input_value, valid_classes, path_to_item,
     return input_value
 
 
+def is_type_nullable(input_type):
+    """
+    Returns true if None is an allowed value for the specified input_type.
+
+    A type is nullable if at least one of the following conditions is true:
+    1. The OAS 'nullable' attribute has been specified,
+    1. The type is the 'null' type,
+    1. The type is a anyOf/oneOf composed schema, and a child schema is
+       the 'null' type.
+    Args:
+        input_type (type): the class of the input_value that we are
+            checking
+    Returns:
+        bool
+    """
+    if input_type is none_type:
+        return True
+    if issubclass(input_type, ModelComposed):
+        # If oneOf/anyOf, check if the 'null' type is one of the allowed types.            
+        for t in input_type._composed_schemas.get('oneOf', ()):
+            if is_type_nullable(t): return True
+        for t in input_type._composed_schemas.get('anyOf', ()):
+            if is_type_nullable(t): return True
+    return False
+
+
 def is_valid_type(input_class_simple, valid_classes):
     """
     Args:
@@ -1149,9 +1175,14 @@ def is_valid_type(input_class_simple, valid_classes):
         bool
     """
     valid_type = input_class_simple in valid_classes
-    if not valid_type and issubclass(input_class_simple, OpenApiModel):
+    if not valid_type and (
+            issubclass(input_class_simple, OpenApiModel) or
+            input_class_simple is none_type):
         for valid_class in valid_classes:
-            if not valid_class.discriminator:
+            if input_class_simple is none_type and is_type_nullable(valid_class):
+                # Schema is oneOf/anyOf and the 'null' type is one of the allowed types.            
+                return True
+            if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator):
                 continue
             discr_propertyname_py = list(valid_class.discriminator.keys())[0]
             discriminator_classes = (

samples/openapi3/client/petstore/python-experimental/README.md

@@ -177,6 +177,7 @@ Class | Method | HTTP request | Description
  - [model_return.ModelReturn](docs/ModelReturn.md)
  - [name.Name](docs/Name.md)
  - [nullable_class.NullableClass](docs/NullableClass.md)
+ - [nullable_shape.NullableShape](docs/NullableShape.md)
  - [number_only.NumberOnly](docs/NumberOnly.md)
  - [order.Order](docs/Order.md)
  - [outer_composite.OuterComposite](docs/OuterComposite.md)
@@ -191,6 +192,7 @@ Class | Method | HTTP request | Description
  - [scalene_triangle.ScaleneTriangle](docs/ScaleneTriangle.md)
  - [shape.Shape](docs/Shape.md)
  - [shape_interface.ShapeInterface](docs/ShapeInterface.md)
+ - [shape_or_null.ShapeOrNull](docs/ShapeOrNull.md)
  - [simple_quadrilateral.SimpleQuadrilateral](docs/SimpleQuadrilateral.md)
  - [special_model_name.SpecialModelName](docs/SpecialModelName.md)
  - [string_boolean_map.StringBooleanMap](docs/StringBooleanMap.md)

samples/openapi3/client/petstore/python-experimental/docs/Drawing.md

@@ -4,6 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **main_shape** | [**shape.Shape**](Shape.md) |  | [optional] 
+**shape_or_null** | [**shape_or_null.ShapeOrNull**](ShapeOrNull.md) |  | [optional] 
+**nullable_shape** | [**nullable_shape.NullableShape, none_type**](NullableShape.md) |  | [optional] 
 **shapes** | [**[shape.Shape]**](Shape.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

samples/openapi3/client/petstore/python-experimental/docs/NullableShape.md

@@ -0,0 +1,13 @@
+# nullable_shape.NullableShape
+
+The value may be a shape or the 'null' value. The 'nullable' attribute was introduced in OAS schema >= 3.0 and has been deprecated in OAS schema >= 3.1.
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shape_type** | **str** |  | 
+**quadrilateral_type** | **str** |  | defaults to nulltype.Null
+**triangle_type** | **str** |  | defaults to nulltype.Null
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

samples/openapi3/client/petstore/python-experimental/docs/ShapeOrNull.md

@@ -0,0 +1,13 @@
+# shape_or_null.ShapeOrNull
+
+The value may be a shape or the 'null' value. This is introduced in OAS schema >= 3.1.
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shape_type** | **str** |  | 
+**quadrilateral_type** | **str** |  | defaults to nulltype.Null
+**triangle_type** | **str** |  | defaults to nulltype.Null
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

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

@@ -95,6 +95,7 @@
 from petstore_api.models.model_return import ModelReturn
 from petstore_api.models.name import Name
 from petstore_api.models.nullable_class import NullableClass
+from petstore_api.models.nullable_shape import NullableShape
 from petstore_api.models.number_only import NumberOnly
 from petstore_api.models.order import Order
 from petstore_api.models.outer_composite import OuterComposite
@@ -109,6 +110,7 @@
 from petstore_api.models.scalene_triangle import ScaleneTriangle
 from petstore_api.models.shape import Shape
 from petstore_api.models.shape_interface import ShapeInterface
+from petstore_api.models.shape_or_null import ShapeOrNull
 from petstore_api.models.simple_quadrilateral import SimpleQuadrilateral
 from petstore_api.models.special_model_name import SpecialModelName
 from petstore_api.models.string_boolean_map import StringBooleanMap

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

@@ -1138,6 +1138,32 @@ def attempt_convert_item(input_value, valid_classes, path_to_item,
     return input_value
 
 
+def is_type_nullable(input_type):
+    """
+    Returns true if None is an allowed value for the specified input_type.
+
+    A type is nullable if at least one of the following conditions is true:
+    1. The OAS 'nullable' attribute has been specified,
+    1. The type is the 'null' type,
+    1. The type is a anyOf/oneOf composed schema, and a child schema is
+       the 'null' type.
+    Args:
+        input_type (type): the class of the input_value that we are
+            checking
+    Returns:
+        bool
+    """
+    if input_type is none_type:
+        return True
+    if issubclass(input_type, ModelComposed):
+        # If oneOf/anyOf, check if the 'null' type is one of the allowed types.            
+        for t in input_type._composed_schemas.get('oneOf', ()):
+            if is_type_nullable(t): return True
+        for t in input_type._composed_schemas.get('anyOf', ()):
+            if is_type_nullable(t): return True
+    return False
+
+
 def is_valid_type(input_class_simple, valid_classes):
     """
     Args:
@@ -1149,9 +1175,14 @@ def is_valid_type(input_class_simple, valid_classes):
         bool
     """
     valid_type = input_class_simple in valid_classes
-    if not valid_type and issubclass(input_class_simple, OpenApiModel):
+    if not valid_type and (
+            issubclass(input_class_simple, OpenApiModel) or
+            input_class_simple is none_type):
         for valid_class in valid_classes:
-            if not valid_class.discriminator:
+            if input_class_simple is none_type and is_type_nullable(valid_class):
+                # Schema is oneOf/anyOf and the 'null' type is one of the allowed types.            
+                return True
+            if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator):
                 continue
             discr_propertyname_py = list(valid_class.discriminator.keys())[0]
             discriminator_classes = (

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

@@ -32,11 +32,21 @@
     str,
     validate_get_composed_info,
 )
+try:
+    from petstore_api.models import nullable_shape
+except ImportError:
+    nullable_shape = sys.modules[
+        'petstore_api.models.nullable_shape']
 try:
     from petstore_api.models import shape
 except ImportError:
     shape = sys.modules[
         'petstore_api.models.shape']
+try:
+    from petstore_api.models import shape_or_null
+except ImportError:
+    shape_or_null = sys.modules[
+        'petstore_api.models.shape_or_null']
 
 
 class Drawing(ModelNormal):
@@ -83,6 +93,8 @@ def openapi_types():
         """
         return {
             'main_shape': (shape.Shape,),  # noqa: E501
+            'shape_or_null': (shape_or_null.ShapeOrNull,),  # noqa: E501
+            'nullable_shape': (nullable_shape.NullableShape, none_type,),  # noqa: E501
             'shapes': ([shape.Shape],),  # noqa: E501
         }
 
@@ -92,6 +104,8 @@ def discriminator():
 
     attribute_map = {
         'main_shape': 'mainShape',  # noqa: E501
+        'shape_or_null': 'shapeOrNull',  # noqa: E501
+        'nullable_shape': 'nullableShape',  # noqa: E501
         'shapes': 'shapes',  # noqa: E501
     }
 
@@ -140,6 +154,8 @@ def __init__(self, _check_type=True, _from_server=False, _path_to_item=(), _conf
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             main_shape (shape.Shape): [optional]  # noqa: E501
+            shape_or_null (shape_or_null.ShapeOrNull): [optional]  # noqa: E501
+            nullable_shape (nullable_shape.NullableShape, none_type): [optional]  # noqa: E501
             shapes ([shape.Shape]): [optional]  # noqa: E501
         """