[Python] fix object arrays giving mypy error "Incompatible types in assignment" in to_dict() (#19223)

* [python] mypy fix for multiple arrays of objects

* [python] mypy test for multiple arrays of objects

Author: VelorumS

modules/openapi-generator/src/main/resources/python/model_generic.mustache

@@ -166,10 +166,10 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
         # override the default output from pydantic by calling `to_dict()` of each item in {{{name}}} (list of list)
         _items = []
         if self.{{{name}}}:
-            for _item in self.{{{name}}}:
-                if _item:
+            for _item_{{{name}}} in self.{{{name}}}:
+                if _item_{{{name}}}:
                     _items.append(
-                         [_inner_item.to_dict() for _inner_item in _item if _inner_item is not None]
+                         [_inner_item.to_dict() for _inner_item in _item_{{{name}}} if _inner_item is not None]
                     )
             _dict['{{{baseName}}}'] = _items
         {{/items.items.isPrimitiveType}}
@@ -180,9 +180,9 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
         # override the default output from pydantic by calling `to_dict()` of each item in {{{name}}} (list)
         _items = []
         if self.{{{name}}}:
-            for _item in self.{{{name}}}:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_{{{name}}} in self.{{{name}}}:
+                if _item_{{{name}}}:
+                    _items.append(_item_{{{name}}}.to_dict())
             _dict['{{{baseName}}}'] = _items
         {{/items.isEnumOrRef}}
         {{/items.isPrimitiveType}}
@@ -194,10 +194,10 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
         # override the default output from pydantic by calling `to_dict()` of each value in {{{name}}} (dict of array)
         _field_dict_of_array = {}
         if self.{{{name}}}:
-            for _key in self.{{{name}}}:
-                if self.{{{name}}}[_key] is not None:
-                    _field_dict_of_array[_key] = [
-                        _item.to_dict() for _item in self.{{{name}}}[_key]
+            for _key_{{{name}}} in self.{{{name}}}:
+                if self.{{{name}}}[_key_{{{name}}}] is not None:
+                    _field_dict_of_array[_key_{{{name}}}] = [
+                        _item.to_dict() for _item in self.{{{name}}}[_key_{{{name}}}]
                     ]
             _dict['{{{baseName}}}'] = _field_dict_of_array
         {{/items.items.isPrimitiveType}}
@@ -208,9 +208,9 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
         # override the default output from pydantic by calling `to_dict()` of each value in {{{name}}} (dict)
         _field_dict = {}
         if self.{{{name}}}:
-            for _key in self.{{{name}}}:
-                if self.{{{name}}}[_key]:
-                    _field_dict[_key] = self.{{{name}}}[_key].to_dict()
+            for _key_{{{name}}} in self.{{{name}}}:
+                if self.{{{name}}}[_key_{{{name}}}]:
+                    _field_dict[_key_{{{name}}}] = self.{{{name}}}[_key_{{{name}}}].to_dict()
             _dict['{{{baseName}}}'] = _field_dict
         {{/items.isEnumOrRef}}
         {{/items.isPrimitiveType}}

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

@@ -2253,6 +2253,18 @@ components:
             enum:
               - fish
               - crab
+    MultiArrays:
+      type: object
+      properties:
+        tags:
+          type: array
+          items:
+            $ref: '#/components/schemas/Tag'
+        files:
+          type: array
+          description: Another array of objects in addition to tags (mypy check to not to reuse the same iterator)
+          items:
+            $ref: '#/components/schemas/File'
     FreeFormObject:
       type: object
       description: A schema consisting only of additional properties

samples/client/echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/models/pet.py

@@ -92,9 +92,9 @@ def to_dict(self) -> Dict[str, Any]:
         # override the default output from pydantic by calling `to_dict()` of each item in tags (list)
         _items = []
         if self.tags:
-            for _item in self.tags:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_tags in self.tags:
+                if _item_tags:
+                    _items.append(_item_tags.to_dict())
             _dict['tags'] = _items
         return _dict
 

samples/client/echo_api/python/openapi_client/models/pet.py

@@ -92,9 +92,9 @@ def to_dict(self) -> Dict[str, Any]:
         # override the default output from pydantic by calling `to_dict()` of each item in tags (list)
         _items = []
         if self.tags:
-            for _item in self.tags:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_tags in self.tags:
+                if _item_tags:
+                    _items.append(_item_tags.to_dict())
             _dict['tags'] = _items
         return _dict
 

samples/openapi3/client/petstore/python-aiohttp/.openapi-generator/FILES

@@ -66,6 +66,7 @@ docs/Model200Response.md
 docs/ModelApiResponse.md
 docs/ModelField.md
 docs/ModelReturn.md
+docs/MultiArrays.md
 docs/Name.md
 docs/NullableClass.md
 docs/NullableProperty.md
@@ -188,6 +189,7 @@ petstore_api/models/model200_response.py
 petstore_api/models/model_api_response.py
 petstore_api/models/model_field.py
 petstore_api/models/model_return.py
+petstore_api/models/multi_arrays.py
 petstore_api/models/name.py
 petstore_api/models/nullable_class.py
 petstore_api/models/nullable_property.py

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

@@ -208,6 +208,7 @@ Class | Method | HTTP request | Description
  - [ModelApiResponse](docs/ModelApiResponse.md)
  - [ModelField](docs/ModelField.md)
  - [ModelReturn](docs/ModelReturn.md)
+ - [MultiArrays](docs/MultiArrays.md)
  - [Name](docs/Name.md)
  - [NullableClass](docs/NullableClass.md)
  - [NullableProperty](docs/NullableProperty.md)

samples/openapi3/client/petstore/python-aiohttp/docs/MultiArrays.md

@@ -0,0 +1,30 @@
+# MultiArrays
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tags** | [**List[Tag]**](Tag.md) |  | [optional] 
+**files** | [**List[File]**](File.md) | Another array of objects in addition to tags (mypy check to not to reuse the same iterator) | [optional] 
+
+## Example
+
+```python
+from petstore_api.models.multi_arrays import MultiArrays
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of MultiArrays from a JSON string
+multi_arrays_instance = MultiArrays.from_json(json)
+# print the JSON string representation of the object
+print(MultiArrays.to_json())
+
+# convert the object into a dict
+multi_arrays_dict = multi_arrays_instance.to_dict()
+# create an instance of MultiArrays from a dict
+multi_arrays_from_dict = MultiArrays.from_dict(multi_arrays_dict)
+```
+[[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-aiohttp/petstore_api/__init__.py

@@ -97,6 +97,7 @@
 from petstore_api.models.model_api_response import ModelApiResponse
 from petstore_api.models.model_field import ModelField
 from petstore_api.models.model_return import ModelReturn
+from petstore_api.models.multi_arrays import MultiArrays
 from petstore_api.models.name import Name
 from petstore_api.models.nullable_class import NullableClass
 from petstore_api.models.nullable_property import NullableProperty

samples/openapi3/client/petstore/python-aiohttp/petstore_api/models/__init__.py

@@ -72,6 +72,7 @@
 from petstore_api.models.model_api_response import ModelApiResponse
 from petstore_api.models.model_field import ModelField
 from petstore_api.models.model_return import ModelReturn
+from petstore_api.models.multi_arrays import MultiArrays
 from petstore_api.models.name import Name
 from petstore_api.models.nullable_class import NullableClass
 from petstore_api.models.nullable_property import NullableProperty

samples/openapi3/client/petstore/python-aiohttp/petstore_api/models/array_of_array_of_model.py

@@ -72,10 +72,10 @@ def to_dict(self) -> Dict[str, Any]:
         # override the default output from pydantic by calling `to_dict()` of each item in another_property (list of list)
         _items = []
         if self.another_property:
-            for _item in self.another_property:
-                if _item:
+            for _item_another_property in self.another_property:
+                if _item_another_property:
                     _items.append(
-                         [_inner_item.to_dict() for _inner_item in _item if _inner_item is not None]
+                         [_inner_item.to_dict() for _inner_item in _item_another_property if _inner_item is not None]
                     )
             _dict['another_property'] = _items
         return _dict