fix(python): support default values for array/map field

Author: CatBraaain

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

@@ -2160,13 +2160,8 @@ private String finalizeType(CodegenProperty cp, PythonType pt) {
                 if (cp.defaultValue == null) {
                     pt.setDefaultValue("None");
                 } else {
-                    if (cp.isArray || cp.isMap) {
-                        // TODO handle default value for array/map
-                        pt.setDefaultValue("None");
-                    } else {
-                        //defaultValue = ;
-                        pt.setDefaultValue(cp.defaultValue);
-                    }
+                    //defaultValue = ;
+                    pt.setDefaultValue(cp.defaultValue);
                 }
             }
 

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

@@ -2910,3 +2910,20 @@ components:
         - 1.0
         - 0.5
         - 0.25
+    ModelWithArrayAndMapDefaults:
+      type: object
+      properties:
+        array:
+          type: array
+          items:
+            type: number
+          default: [1, 2]
+        map:
+          type: object
+          properties:
+            key1:
+              type: string
+              default: "value1"
+            key2:
+              type: string
+              default: "value2"

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

@@ -0,0 +1,30 @@
+# ModelWithArrayAndMapDefaults
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**array** | **List[float]** |  | [optional] [default to [1,2]]
+**map** | **Dict[str, str]** |  | [optional] 
+
+## Example
+
+```python
+from petstore_api.models.model_with_array_and_map_defaults import ModelWithArrayAndMapDefaults
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ModelWithArrayAndMapDefaults from a JSON string
+model_with_array_and_map_defaults_instance = ModelWithArrayAndMapDefaults.from_json(json)
+# print the JSON string representation of the object
+print(ModelWithArrayAndMapDefaults.to_json())
+
+# convert the object into a dict
+model_with_array_and_map_defaults_dict = model_with_array_and_map_defaults_instance.to_dict()
+# create an instance of ModelWithArrayAndMapDefaults from a dict
+model_with_array_and_map_defaults_from_dict = ModelWithArrayAndMapDefaults.from_dict(model_with_array_and_map_defaults_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/models/model_with_array_and_map_defaults.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    OpenAPI Petstore
+
+    This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModelWithArrayAndMapDefaults(BaseModel):
+    """
+    ModelWithArrayAndMapDefaults
+    """ # noqa: E501
+    array: Optional[List[float]] = [1,2]
+    map: Optional[Dict[str, StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["array", "map"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ModelWithArrayAndMapDefaults from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ModelWithArrayAndMapDefaults from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "array": obj.get("array"),
+            "map": obj.get("map")
+        })
+        return _obj
+
+

samples/openapi3/client/petstore/python-aiohttp/test/test_model_with_array_and_map_defaults.py

@@ -0,0 +1,56 @@
+# coding: utf-8
+
+"""
+    OpenAPI Petstore
+
+    This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from petstore_api.models.model_with_array_and_map_defaults import ModelWithArrayAndMapDefaults
+
+class TestModelWithArrayAndMapDefaults(unittest.TestCase):
+    """ModelWithArrayAndMapDefaults unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> ModelWithArrayAndMapDefaults:
+        """Test ModelWithArrayAndMapDefaults
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `ModelWithArrayAndMapDefaults`
+        """
+        model = ModelWithArrayAndMapDefaults()
+        if include_optional:
+            return ModelWithArrayAndMapDefaults(
+                array = [
+                    1.337
+                    ],
+                map = {
+                    'key' : ''
+                    }
+            )
+        else:
+            return ModelWithArrayAndMapDefaults(
+        )
+        """
+
+    def testModelWithArrayAndMapDefaults(self):
+        """Test ModelWithArrayAndMapDefaults"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/docs/ModelWithArrayAndMapDefaults.md

@@ -0,0 +1,29 @@
+# ModelWithArrayAndMapDefaults
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**array** | **List[float]** |  | [optional] [default to [1,2]]
+**map** | **Dict[str, str]** |  | [optional] 
+
+## Example
+
+```python
+from petstore_api.models.model_with_array_and_map_defaults import ModelWithArrayAndMapDefaults
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ModelWithArrayAndMapDefaults from a JSON string
+model_with_array_and_map_defaults_instance = ModelWithArrayAndMapDefaults.from_json(json)
+# print the JSON string representation of the object
+print ModelWithArrayAndMapDefaults.to_json()
+
+# convert the object into a dict
+model_with_array_and_map_defaults_dict = model_with_array_and_map_defaults_instance.to_dict()
+# create an instance of ModelWithArrayAndMapDefaults from a dict
+model_with_array_and_map_defaults_from_dict = ModelWithArrayAndMapDefaults.from_dict(model_with_array_and_map_defaults_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-pydantic-v1-aiohttp/petstore_api/models/model_with_array_and_map_defaults.py

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+"""
+    OpenAPI Petstore
+
+    This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Dict, List, Optional
+from pydantic import BaseModel, StrictStr, conlist
+
+class ModelWithArrayAndMapDefaults(BaseModel):
+    """
+    ModelWithArrayAndMapDefaults
+    """
+    array: Optional[conlist(float)] = None
+    map: Optional[Dict[str, StrictStr]] = None
+    __properties = ["array", "map"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ModelWithArrayAndMapDefaults:
+        """Create an instance of ModelWithArrayAndMapDefaults from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ModelWithArrayAndMapDefaults:
+        """Create an instance of ModelWithArrayAndMapDefaults from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ModelWithArrayAndMapDefaults.parse_obj(obj)
+
+        _obj = ModelWithArrayAndMapDefaults.parse_obj({
+            "array": obj.get("array"),
+            "map": obj.get("map")
+        })
+        return _obj
+
+

samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/test/test_model_with_array_and_map_defaults.py

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+"""
+    OpenAPI Petstore
+
+    This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+import datetime
+
+from petstore_api.models.model_with_array_and_map_defaults import ModelWithArrayAndMapDefaults  # noqa: E501
+
+class TestModelWithArrayAndMapDefaults(unittest.TestCase):
+    """ModelWithArrayAndMapDefaults unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> ModelWithArrayAndMapDefaults:
+        """Test ModelWithArrayAndMapDefaults
+            include_option is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `ModelWithArrayAndMapDefaults`
+        """
+        model = ModelWithArrayAndMapDefaults()  # noqa: E501
+        if include_optional:
+            return ModelWithArrayAndMapDefaults(
+                array = [
+                    1.337
+                    ],
+                map = {
+                    'key' : ''
+                    }
+            )
+        else:
+            return ModelWithArrayAndMapDefaults(
+        )
+        """
+
+    def testModelWithArrayAndMapDefaults(self):
+        """Test ModelWithArrayAndMapDefaults"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()