:feat: Fixed tests for lists

Author: MarcoMuellner

src/openapi_python_generator/language_converters/python/model_generator.py

@@ -131,7 +131,7 @@ def type_converter(schema: Schema,  required: bool = False, model_name: str | No
     elif schema.type == "array":
         retVal = pre_type + "List["
         if isinstance(schema.items, Reference):
-            converted_reference = _generate_property_from_reference(model_name, "", schema.items, schema)
+            converted_reference = _generate_property_from_reference(model_name, "", schema.items, schema, required)
             import_types = converted_reference.type.import_types
             original_type = "array<" + converted_reference.type.original_type + ">"
             retVal += converted_reference.type.converted_type
@@ -183,21 +183,22 @@ def _generate_property_from_schema(
 
 
 def _generate_property_from_reference(
-        model_name: str, name: str, reference: Reference, parent_schema: Optional[Schema] = None,
+        model_name: str, name: str, reference: Reference, parent_schema: Optional[Schema] = None, force_required: bool = False
 ) -> Property:
     """
     Generates a property from a reference. It takes the name of the reference as the type, and then
     returns a property type
     :param name: Name of the schema
     :param reference: reference to be converted
     :param parent_schema: Component this belongs to
+    :param force_required: Force the property to be required
     :return: Property and model to be imported by the file
     """
     required = (
         parent_schema is not None
         and parent_schema.required is not None
         and name in parent_schema.required
-    )
+    ) or force_required
     import_model = reference.ref.split("/")[-1]
 
     if import_model == model_name:

tests/regression/test_issue_9.py renamed to tests/regression/test_issue_11.py

@@ -1,5 +1,6 @@
 import json
 import os
+import traceback
 from datetime import datetime
 
 import orjson
@@ -205,9 +206,14 @@ def test_generate_code(model_data_with_cleanup, library, use_orjson):
     exec(exec_code_base, globals(), _locals)
     assert root_route.called
 
-    exec_code_base = f"from .test_result import *\nresp_result = get_users_users_get()"
+    exec_code_base = f"try:\n\tfrom .test_result import *\n\tresp_result = get_users_users_get()\nexcept Exception as e:\n\tprint(e)\n\traise e"
 
-    exec(exec_code_base, globals(), _locals)
+    try:
+        exec(exec_code_base, globals(), _locals)
+    except Exception as e:
+        print(e)
+        print(traceback.format_exc())
+        raise e
 
     exec(
         "from .test_result.services.general_service import *\nassert isinstance(resp_result, list)",

tests/test_generated_code.py

@@ -59,7 +59,7 @@
         (
             Schema(type="array", items=Reference(ref="#/components/schemas/test_name")),
             TypeConversion(
-                original_type="array<test_name>",
+                original_type="array<#/components/schemas/test_name>",
                 converted_type="List[test_name]",
                 import_types=["from .test_name import test_name"],
             ),
@@ -72,10 +72,19 @@
 )
 def test_type_converter_simple(test_openapi_types, expected_python_types):
     assert type_converter(test_openapi_types, True) == expected_python_types
-    assert (
-        type_converter(test_openapi_types, False).converted_type
-        == "Optional[" + expected_python_types.converted_type + "]"
-    )
+
+    if test_openapi_types.type == "array" and isinstance(test_openapi_types.items, Reference):
+        expected_type = expected_python_types.converted_type.split("[")[-1].split("]")[0]
+
+        assert (
+            type_converter(test_openapi_types, False).converted_type
+            == "Optional[List[Optional[" + expected_type + "]]]"
+        )
+    else:
+        assert (
+            type_converter(test_openapi_types, False).converted_type
+            == "Optional[" + expected_python_types.converted_type + "]"
+        )
 
 
 @pytest.mark.parametrize(
@@ -120,7 +129,7 @@ def test_type_converter_simple(test_openapi_types, expected_python_types):
         (
             Schema(type="array", items=Reference(ref="#/components/schemas/test_name")),
             TypeConversion(
-                original_type="array<test_name>",
+                original_type="array<#/components/schemas/test_name>",
                 converted_type="List[test_name]",
                 import_types=["from .test_name import test_name"],
             ),
@@ -135,11 +144,19 @@ def test_type_converter_simple_orjson(test_openapi_types, expected_python_types)
     orjson_usage = common.get_use_orjson()
     common.set_use_orjson(True)
     assert type_converter(test_openapi_types, True) == expected_python_types
-    assert (
-        type_converter(test_openapi_types, False).converted_type
-        == "Optional[" + expected_python_types.converted_type + "]"
-    )
-    common.set_use_orjson(orjson_usage)
+    if test_openapi_types.type == "array" and isinstance(test_openapi_types.items, Reference):
+        expected_type = expected_python_types.converted_type.split("[")[-1].split("]")[0]
+
+        assert (
+            type_converter(test_openapi_types, False).converted_type
+            == "Optional[List[Optional[" + expected_type + "]]]"
+        )
+    else:
+        assert (
+            type_converter(test_openapi_types, False).converted_type
+            == "Optional[" + expected_python_types.converted_type + "]"
+        )
+        common.set_use_orjson(orjson_usage)
 
 
 def test_type_converter_all_of_reference():
@@ -303,7 +320,7 @@ def test_type_converter_property_reference(
     test_name, test_reference, parent_schema, expected_property
 ):
     assert (
-        _generate_property_from_reference(test_name, test_reference, parent_schema)
+        _generate_property_from_reference("",test_name, test_reference, parent_schema)
         == expected_property
     )
 

tests/test_model_generator.py

@@ -370,6 +370,47 @@ def test_generate_query_params(test_openapi_operation, expected_result):
                 complex_type=True,
             ),
         ),
+        (
+            Operation(
+                responses={
+                    "200": Response(
+                        description="Successful Response",
+                        content={"application/json": MediaType(media_type_schema=Reference(ref="#/components/schemas/User"))}
+                    )
+                }
+            ),
+            OpReturnType(
+                type=TypeConversion(
+                    original_type="#/components/schemas/User",
+                    converted_type="User",
+                    import_types=["User"],
+                ),
+                status_code="200",
+                complex_type=True,
+            )
+
+        ),
+        (
+                Operation(
+                    responses={
+                        "200": Response(
+                            description="Successful Response",
+                            content={"application/json": MediaType(media_type_schema=Schema(type='array',items=Reference(ref="#/components/schemas/User")))}
+                        )
+                    }
+                ),
+                OpReturnType(
+                    type=TypeConversion(
+                        original_type="array<#/components/schemas/User>",
+                        converted_type="List[User]",
+                        import_types=['from .User import User'],
+                    ),
+                    status_code="200",
+                    complex_type=True,
+                    list_type="User"
+                )
+
+        ),
         (
             Operation(
                 responses={