[Python] Fix the post processing of string enums (#20976)

* fix/ x-enum-varnames in python

* make x-enum-varnames examples more clear

* make x enum varname usage more explicit

* fix tests

* trigger tests

* trigger tests once again...

* fix more tests

Author: PidgeyBE

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

@@ -958,8 +958,10 @@ private ModelsMap postProcessModelsMap(ModelsMap objs) {
                 for (Map<String, Object> enumVars : (List<Map<String, Object>>) model.getAllowableValues().get("enumVars")) {
                     if ((Boolean) enumVars.get("isString")) {
                         model.vendorExtensions.putIfAbsent("x-py-enum-type", "str");
-                        // update `name`, e.g.
-                        enumVars.put("name", toEnumVariableName((String) enumVars.get("value"), "str"));
+                        // Do not overwrite the variable name if already set through x-enum-varnames
+                        if (model.vendorExtensions.get("x-enum-varnames") == null) {
+                            enumVars.put("name", toEnumVariableName((String) enumVars.get("value"), "str"));
+                        }
                     } else {
                         model.vendorExtensions.putIfAbsent("x-py-enum-type", "int");
                         // Do not overwrite the variable name if already set through x-enum-varnames

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

@@ -2102,35 +2102,6 @@ components:
           enum:
             - 1.1
             - -1.2
-        enum_number_vendor_ext:
-          type: integer
-          format: int32
-          enum:
-            - 42
-            - 18
-            - 56
-          x-enum-descriptions:
-            - 'Description for 42'
-            - 'Description for 18'
-            - 'Description for 56'
-          x-enum-varnames:
-            - FortyTwo
-            - Eigtheen
-            - FiftySix
-        enum_string_vendor_ext:
-          type: string
-          enum:
-            - FOO
-            - Bar
-            - baz
-          x-enum-descriptions:
-            - 'Description for FOO'
-            - 'Description for Bar'
-            - 'Description for baz'
-          x-enum-varnames:
-            - FOOVar
-            - BarVar
-            - bazVar
         enum_string_single_member:
           type: string
           enum:
@@ -2148,6 +2119,10 @@ components:
           $ref: '#/components/schemas/OuterEnumDefaultValue'
         outerEnumIntegerDefaultValue:
           $ref: '#/components/schemas/OuterEnumIntegerDefaultValue'
+        enumNumberVendorExt:
+          $ref: '#/components/schemas/EnumNumberVendorExt'
+        enumStringVendorExt:
+          $ref: '#/components/schemas/EnumStringVendorExt'
     AdditionalPropertiesClass:
       type: object
       properties:
@@ -2339,6 +2314,35 @@ components:
       - 1
       - 2
       example: 2
+    EnumNumberVendorExt:
+      type: integer
+      format: int32
+      enum:
+        - 42
+        - 18
+        - 56
+      x-enum-descriptions:
+        - 'Description for 42'
+        - 'Description for 18'
+        - 'Description for 56'
+      x-enum-varnames:
+        - FortyTwo
+        - Eigtheen
+        - FiftySix
+    EnumStringVendorExt:
+      type: string
+      enum:
+        - FOO
+        - Bar
+        - baz
+      x-enum-descriptions:
+        - 'Description for FOO'
+        - 'Description for Bar'
+        - 'Description for baz'
+      x-enum-varnames:
+        - FOO_XEnumVarname
+        - BarVar_XEnumVarname
+        - bazVar_XEnumVarname
     OuterEnumDefaultValue:
       type: string
       enum:

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

@@ -39,8 +39,10 @@ docs/Dog.md
 docs/DummyModel.md
 docs/EnumArrays.md
 docs/EnumClass.md
+docs/EnumNumberVendorExt.md
 docs/EnumString1.md
 docs/EnumString2.md
+docs/EnumStringVendorExt.md
 docs/EnumTest.md
 docs/FakeApi.md
 docs/FakeClassnameTags123Api.md
@@ -167,8 +169,10 @@ petstore_api/models/dog.py
 petstore_api/models/dummy_model.py
 petstore_api/models/enum_arrays.py
 petstore_api/models/enum_class.py
+petstore_api/models/enum_number_vendor_ext.py
 petstore_api/models/enum_string1.py
 petstore_api/models/enum_string2.py
+petstore_api/models/enum_string_vendor_ext.py
 petstore_api/models/enum_test.py
 petstore_api/models/feeding.py
 petstore_api/models/file.py

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

@@ -185,8 +185,10 @@ Class | Method | HTTP request | Description
  - [DummyModel](docs/DummyModel.md)
  - [EnumArrays](docs/EnumArrays.md)
  - [EnumClass](docs/EnumClass.md)
+ - [EnumNumberVendorExt](docs/EnumNumberVendorExt.md)
  - [EnumString1](docs/EnumString1.md)
  - [EnumString2](docs/EnumString2.md)
+ - [EnumStringVendorExt](docs/EnumStringVendorExt.md)
  - [EnumTest](docs/EnumTest.md)
  - [Feeding](docs/Feeding.md)
  - [File](docs/File.md)

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

@@ -0,0 +1,14 @@
+# EnumNumberVendorExt
+
+
+## Enum
+
+* `FortyTwo` (value: `42`)
+
+* `Eigtheen` (value: `18`)
+
+* `FiftySix` (value: `56`)
+
+[[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/docs/EnumStringVendorExt.md

@@ -0,0 +1,14 @@
+# EnumStringVendorExt
+
+
+## Enum
+
+* `FOO_XEnumVarname` (value: `'FOO'`)
+
+* `BarVar_XEnumVarname` (value: `'Bar'`)
+
+* `bazVar_XEnumVarname` (value: `'baz'`)
+
+[[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/docs/EnumTest.md

@@ -10,14 +10,14 @@ Name | Type | Description | Notes
 **enum_integer_default** | **int** |  | [optional] [default to 5]
 **enum_integer** | **int** |  | [optional] 
 **enum_number** | **float** |  | [optional] 
-**enum_number_vendor_ext** | **int** |  | [optional] 
-**enum_string_vendor_ext** | **str** |  | [optional] 
 **enum_string_single_member** | **str** |  | [optional] 
 **enum_integer_single_member** | **int** |  | [optional] 
 **outer_enum** | [**OuterEnum**](OuterEnum.md) |  | [optional] 
 **outer_enum_integer** | [**OuterEnumInteger**](OuterEnumInteger.md) |  | [optional] 
 **outer_enum_default_value** | [**OuterEnumDefaultValue**](OuterEnumDefaultValue.md) |  | [optional] [default to OuterEnumDefaultValue.PLACED]
 **outer_enum_integer_default_value** | [**OuterEnumIntegerDefaultValue**](OuterEnumIntegerDefaultValue.md) |  | [optional] [default to OuterEnumIntegerDefaultValue.NUMBER_0]
+**enum_number_vendor_ext** | [**EnumNumberVendorExt**](EnumNumberVendorExt.md) |  | [optional] 
+**enum_string_vendor_ext** | [**EnumStringVendorExt**](EnumStringVendorExt.md) |  | [optional] 
 
 ## Example
 

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

@@ -73,8 +73,10 @@
 from petstore_api.models.dummy_model import DummyModel
 from petstore_api.models.enum_arrays import EnumArrays
 from petstore_api.models.enum_class import EnumClass
+from petstore_api.models.enum_number_vendor_ext import EnumNumberVendorExt
 from petstore_api.models.enum_string1 import EnumString1
 from petstore_api.models.enum_string2 import EnumString2
+from petstore_api.models.enum_string_vendor_ext import EnumStringVendorExt
 from petstore_api.models.enum_test import EnumTest
 from petstore_api.models.feeding import Feeding
 from petstore_api.models.file import File

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

@@ -48,8 +48,10 @@
 from petstore_api.models.dummy_model import DummyModel
 from petstore_api.models.enum_arrays import EnumArrays
 from petstore_api.models.enum_class import EnumClass
+from petstore_api.models.enum_number_vendor_ext import EnumNumberVendorExt
 from petstore_api.models.enum_string1 import EnumString1
 from petstore_api.models.enum_string2 import EnumString2
+from petstore_api.models.enum_string_vendor_ext import EnumStringVendorExt
 from petstore_api.models.enum_test import EnumTest
 from petstore_api.models.feeding import Feeding
 from petstore_api.models.file import File

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

@@ -0,0 +1,38 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class EnumNumberVendorExt(int, Enum):
+    """
+    EnumNumberVendorExt
+    """
+
+    """
+    allowed enum values
+    """
+    FortyTwo = 42
+    Eigtheen = 18
+    FiftySix = 56
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of EnumNumberVendorExt from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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

@@ -0,0 +1,38 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class EnumStringVendorExt(str, Enum):
+    """
+    EnumStringVendorExt
+    """
+
+    """
+    allowed enum values
+    """
+    FOO_XEnumVarname = 'FOO'
+    BarVar_XEnumVarname = 'Bar'
+    bazVar_XEnumVarname = 'baz'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of EnumStringVendorExt from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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

@@ -19,6 +19,8 @@
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
+from petstore_api.models.enum_number_vendor_ext import EnumNumberVendorExt
+from petstore_api.models.enum_string_vendor_ext import EnumStringVendorExt
 from petstore_api.models.outer_enum import OuterEnum
 from petstore_api.models.outer_enum_default_value import OuterEnumDefaultValue
 from petstore_api.models.outer_enum_integer import OuterEnumInteger
@@ -35,15 +37,15 @@ class EnumTest(BaseModel):
     enum_integer_default: Optional[StrictInt] = 5
     enum_integer: Optional[StrictInt] = None
     enum_number: Optional[float] = None
-    enum_number_vendor_ext: Optional[StrictInt] = None
-    enum_string_vendor_ext: Optional[StrictStr] = None
     enum_string_single_member: Optional[StrictStr] = None
     enum_integer_single_member: Optional[StrictInt] = None
     outer_enum: Optional[OuterEnum] = Field(default=None, alias="outerEnum")
     outer_enum_integer: Optional[OuterEnumInteger] = Field(default=None, alias="outerEnumInteger")
     outer_enum_default_value: Optional[OuterEnumDefaultValue] = Field(default=OuterEnumDefaultValue.PLACED, alias="outerEnumDefaultValue")
     outer_enum_integer_default_value: Optional[OuterEnumIntegerDefaultValue] = Field(default=OuterEnumIntegerDefaultValue.NUMBER_0, alias="outerEnumIntegerDefaultValue")
-    __properties: ClassVar[List[str]] = ["enum_string", "enum_string_required", "enum_integer_default", "enum_integer", "enum_number", "enum_number_vendor_ext", "enum_string_vendor_ext", "enum_string_single_member", "enum_integer_single_member", "outerEnum", "outerEnumInteger", "outerEnumDefaultValue", "outerEnumIntegerDefaultValue"]
+    enum_number_vendor_ext: Optional[EnumNumberVendorExt] = Field(default=None, alias="enumNumberVendorExt")
+    enum_string_vendor_ext: Optional[EnumStringVendorExt] = Field(default=None, alias="enumStringVendorExt")
+    __properties: ClassVar[List[str]] = ["enum_string", "enum_string_required", "enum_integer_default", "enum_integer", "enum_number", "enum_string_single_member", "enum_integer_single_member", "outerEnum", "outerEnumInteger", "outerEnumDefaultValue", "outerEnumIntegerDefaultValue", "enumNumberVendorExt", "enumStringVendorExt"]
 
     @field_validator('enum_string')
     def enum_string_validate_enum(cls, value):
@@ -92,26 +94,6 @@ def enum_number_validate_enum(cls, value):
             raise ValueError("must be one of enum values (1.1, -1.2)")
         return value
 
-    @field_validator('enum_number_vendor_ext')
-    def enum_number_vendor_ext_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set([42, 18, 56]):
-            raise ValueError("must be one of enum values (42, 18, 56)")
-        return value
-
-    @field_validator('enum_string_vendor_ext')
-    def enum_string_vendor_ext_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['FOO', 'Bar', 'baz']):
-            raise ValueError("must be one of enum values ('FOO', 'Bar', 'baz')")
-        return value
-
     @field_validator('enum_string_single_member')
     def enum_string_single_member_validate_enum(cls, value):
         """Validates the enum"""
@@ -193,14 +175,14 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "enum_integer_default": obj.get("enum_integer_default") if obj.get("enum_integer_default") is not None else 5,
             "enum_integer": obj.get("enum_integer"),
             "enum_number": obj.get("enum_number"),
-            "enum_number_vendor_ext": obj.get("enum_number_vendor_ext"),
-            "enum_string_vendor_ext": obj.get("enum_string_vendor_ext"),
             "enum_string_single_member": obj.get("enum_string_single_member"),
             "enum_integer_single_member": obj.get("enum_integer_single_member"),
             "outerEnum": obj.get("outerEnum"),
             "outerEnumInteger": obj.get("outerEnumInteger"),
             "outerEnumDefaultValue": obj.get("outerEnumDefaultValue") if obj.get("outerEnumDefaultValue") is not None else OuterEnumDefaultValue.PLACED,
-            "outerEnumIntegerDefaultValue": obj.get("outerEnumIntegerDefaultValue") if obj.get("outerEnumIntegerDefaultValue") is not None else OuterEnumIntegerDefaultValue.NUMBER_0
+            "outerEnumIntegerDefaultValue": obj.get("outerEnumIntegerDefaultValue") if obj.get("outerEnumIntegerDefaultValue") is not None else OuterEnumIntegerDefaultValue.NUMBER_0,
+            "enumNumberVendorExt": obj.get("enumNumberVendorExt"),
+            "enumStringVendorExt": obj.get("enumStringVendorExt")
         })
         return _obj
 

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

@@ -0,0 +1,33 @@
+# 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.enum_number_vendor_ext import EnumNumberVendorExt
+
+class TestEnumNumberVendorExt(unittest.TestCase):
+    """EnumNumberVendorExt unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testEnumNumberVendorExt(self):
+        """Test EnumNumberVendorExt"""
+        # inst = EnumNumberVendorExt()
+
+if __name__ == '__main__':
+    unittest.main()