python-pydantic-v1: Keep trailing commas for enum validation tuples (O…

…penAPITools#19985) * python-pydantic-v1: Keep trailing commas for tuples when enum has just single member * Update samples * Add test for single member enums * Refactor test name
takkiraz · Nov 2, 2024 · 67af02c · 67af02c
1 parent 66c7b2f
commit 67af02c
Show file tree

Hide file tree

Showing 35 changed files with 188 additions and 54 deletions.
diff --git a/modules/openapi-generator/src/main/resources/python-fastapi/model_generic.mustache b/modules/openapi-generator/src/main/resources/python-fastapi/model_generic.mustache
@@ -69,11 +69,11 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
         {{/required}}
         {{#isArray}}
         for i in value:
-            if i not in ({{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}):
+            if i not in ({{#allowableValues}}{{#enumVars}}{{{value}}},{{^-last}} {{/-last}}{{/enumVars}}{{/allowableValues}}):
                 raise ValueError("each list item must be one of ({{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}})")
         {{/isArray}}
         {{^isArray}}
-        if value not in ({{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}):
+        if value not in ({{#allowableValues}}{{#enumVars}}{{{value}}},{{^-last}} {{/-last}}{{/enumVars}}{{/allowableValues}}):
             raise ValueError("must be one of enum values ({{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}})")
         {{/isArray}}
         return value

diff --git a/modules/openapi-generator/src/main/resources/python-pydantic-v1/model_generic.mustache b/modules/openapi-generator/src/main/resources/python-pydantic-v1/model_generic.mustache
@@ -74,11 +74,11 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
         {{/required}}
         {{#isArray}}
         for i in value:
-            if i not in ({{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}):
+            if i not in ({{#allowableValues}}{{#enumVars}}{{{value}}},{{^-last}} {{/-last}}{{/enumVars}}{{/allowableValues}}):
                 raise ValueError("each list item must be one of ({{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}})")
         {{/isArray}}
         {{^isArray}}
-        if value not in ({{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}):
+        if value not in ({{#allowableValues}}{{#enumVars}}{{{value}}},{{^-last}} {{/-last}}{{/enumVars}}{{/allowableValues}}):
             raise ValueError("must be one of enum values ({{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}})")
         {{/isArray}}
         return value

diff --git a/...erator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing.yaml b/...erator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing.yaml
@@ -2124,6 +2124,15 @@ components:
             - FOOVar
             - BarVar
             - bazVar
+        enum_string_single_member:
+          type: string
+          enum:
+            - 'abc'
+        enum_integer_single_member:
+          type: integer
+          format: int32
+          enum:
+            - 100
         outerEnum:
           $ref: '#/components/schemas/OuterEnum'
         outerEnumInteger:

diff --git a/samples/client/echo_api/python-pydantic-v1/openapi_client/models/default_value.py b/samples/client/echo_api/python-pydantic-v1/openapi_client/models/default_value.py
@@ -44,7 +44,7 @@ def array_string_enum_default_validate_enum(cls, value):
             return value
 
         for i in value:
-            if i not in ('success', 'failure', 'unclassified'):
+            if i not in ('success', 'failure', 'unclassified',):
                 raise ValueError("each list item must be one of ('success', 'failure', 'unclassified')")
         return value
 

diff --git a/samples/client/echo_api/python-pydantic-v1/openapi_client/models/pet.py b/samples/client/echo_api/python-pydantic-v1/openapi_client/models/pet.py
@@ -42,7 +42,7 @@ def status_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in ('available', 'pending', 'sold'):
+        if value not in ('available', 'pending', 'sold',):
             raise ValueError("must be one of enum values ('available', 'pending', 'sold')")
         return value
 

diff --git a/samples/client/echo_api/python-pydantic-v1/openapi_client/models/query.py b/samples/client/echo_api/python-pydantic-v1/openapi_client/models/query.py
@@ -37,7 +37,7 @@ def outcomes_validate_enum(cls, value):
             return value
 
         for i in value:
-            if i not in ('SUCCESS', 'FAILURE', 'SKIPPED'):
+            if i not in ('SUCCESS', 'FAILURE', 'SKIPPED',):
                 raise ValueError("each list item must be one of ('SUCCESS', 'FAILURE', 'SKIPPED')")
         return value
 

diff --git a/samples/openapi3/client/petstore/python-aiohttp/docs/EnumTest.md b/samples/openapi3/client/petstore/python-aiohttp/docs/EnumTest.md
@@ -12,6 +12,8 @@ Name | Type | Description | Notes
 **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]

diff --git a/samples/openapi3/client/petstore/python-aiohttp/petstore_api/models/enum_test.py b/samples/openapi3/client/petstore/python-aiohttp/petstore_api/models/enum_test.py
@@ -37,11 +37,13 @@ class EnumTest(BaseModel):
     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", "outerEnum", "outerEnumInteger", "outerEnumDefaultValue", "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"]
 
     @field_validator('enum_string')
     def enum_string_validate_enum(cls, value):
@@ -110,6 +112,26 @@ def enum_string_vendor_ext_validate_enum(cls, value):
             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"""
+        if value is None:
+            return value
+
+        if value not in set(['abc']):
+            raise ValueError("must be one of enum values ('abc')")
+        return value
+
+    @field_validator('enum_integer_single_member')
+    def enum_integer_single_member_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set([100]):
+            raise ValueError("must be one of enum values (100)")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -173,6 +195,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "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,

diff --git a/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/docs/EnumTest.md b/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/docs/EnumTest.md
@@ -11,6 +11,8 @@ Name | Type | Description | Notes
 **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] 

diff --git a/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/bathing.py b/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/bathing.py
@@ -33,14 +33,14 @@ class Bathing(BaseModel):
     @validator('task_name')
     def task_name_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('cleaning_deep'):
+        if value not in ('cleaning_deep',):
             raise ValueError("must be one of enum values ('cleaning_deep')")
         return value
 
     @validator('function_name')
     def function_name_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('care_nourish'):
+        if value not in ('care_nourish',):
             raise ValueError("must be one of enum values ('care_nourish')")
         return value
 

diff --git a/...es/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/enum_arrays.py b/...es/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/enum_arrays.py
@@ -35,7 +35,7 @@ def just_symbol_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in ('>=', '$'):
+        if value not in ('>=', '$',):
             raise ValueError("must be one of enum values ('>=', '$')")
         return value
 
@@ -46,7 +46,7 @@ def array_enum_validate_enum(cls, value):
             return value
 
         for i in value:
-            if i not in ('fish', 'crab'):
+            if i not in ('fish', 'crab',):
                 raise ValueError("each list item must be one of ('fish', 'crab')")
         return value
 

diff --git a/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/enum_test.py b/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/enum_test.py
@@ -36,26 +36,28 @@ class EnumTest(BaseModel):
     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=None, alias="outerEnumDefaultValue")
     outer_enum_integer_default_value: Optional[OuterEnumIntegerDefaultValue] = Field(default=None, alias="outerEnumIntegerDefaultValue")
-    __properties = ["enum_string", "enum_string_required", "enum_integer_default", "enum_integer", "enum_number", "enum_number_vendor_ext", "enum_string_vendor_ext", "outerEnum", "outerEnumInteger", "outerEnumDefaultValue", "outerEnumIntegerDefaultValue"]
+    __properties = ["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"]
 
     @validator('enum_string')
     def enum_string_validate_enum(cls, value):
         """Validates the enum"""
         if value is None:
             return value
 
-        if value not in ('UPPER', 'lower', ''):
+        if value not in ('UPPER', 'lower', '',):
             raise ValueError("must be one of enum values ('UPPER', 'lower', '')")
         return value
 
     @validator('enum_string_required')
     def enum_string_required_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('UPPER', 'lower', ''):
+        if value not in ('UPPER', 'lower', '',):
             raise ValueError("must be one of enum values ('UPPER', 'lower', '')")
         return value
 
@@ -65,7 +67,7 @@ def enum_integer_default_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in (1, 5, 14):
+        if value not in (1, 5, 14,):
             raise ValueError("must be one of enum values (1, 5, 14)")
         return value
 
@@ -75,7 +77,7 @@ def enum_integer_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in (1, -1):
+        if value not in (1, -1,):
             raise ValueError("must be one of enum values (1, -1)")
         return value
 
@@ -85,7 +87,7 @@ def enum_number_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in (1.1, -1.2):
+        if value not in (1.1, -1.2,):
             raise ValueError("must be one of enum values (1.1, -1.2)")
         return value
 
@@ -95,7 +97,7 @@ def enum_number_vendor_ext_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in (42, 18, 56):
+        if value not in (42, 18, 56,):
             raise ValueError("must be one of enum values (42, 18, 56)")
         return value
 
@@ -105,10 +107,30 @@ def enum_string_vendor_ext_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in ('FOO', 'Bar', 'baz'):
+        if value not in ('FOO', 'Bar', 'baz',):
             raise ValueError("must be one of enum values ('FOO', 'Bar', 'baz')")
         return value
 
+    @validator('enum_string_single_member')
+    def enum_string_single_member_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in ('abc',):
+            raise ValueError("must be one of enum values ('abc')")
+        return value
+
+    @validator('enum_integer_single_member')
+    def enum_integer_single_member_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in (100,):
+            raise ValueError("must be one of enum values (100)")
+        return value
+
     class Config:
         """Pydantic configuration"""
         allow_population_by_field_name = True
@@ -157,6 +179,8 @@ def from_dict(cls, obj: dict) -> EnumTest:
             "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"),
             "outer_enum": obj.get("outerEnum"),
             "outer_enum_integer": obj.get("outerEnumInteger"),
             "outer_enum_default_value": obj.get("outerEnumDefaultValue"),

diff --git a/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/feeding.py b/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/feeding.py
@@ -33,14 +33,14 @@ class Feeding(BaseModel):
     @validator('task_name')
     def task_name_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('cleaning'):
+        if value not in ('cleaning',):
             raise ValueError("must be one of enum values ('cleaning')")
         return value
 
     @validator('function_name')
     def function_name_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('care_nourish'):
+        if value not in ('care_nourish',):
             raise ValueError("must be one of enum values ('care_nourish')")
         return value
 

diff --git a/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/map_test.py b/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/map_test.py
@@ -37,7 +37,7 @@ def map_of_enum_string_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in ('UPPER', 'lower'):
+        if value not in ('UPPER', 'lower',):
             raise ValueError("must be one of enum values ('UPPER', 'lower')")
         return value
 

diff --git a/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/order.py b/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/order.py
@@ -39,7 +39,7 @@ def status_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in ('placed', 'approved', 'delivered'):
+        if value not in ('placed', 'approved', 'delivered',):
             raise ValueError("must be one of enum values ('placed', 'approved', 'delivered')")
         return value
 

diff --git a/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/pet.py b/samples/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/pet.py
@@ -41,7 +41,7 @@ def status_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in ('available', 'pending', 'sold'):
+        if value not in ('available', 'pending', 'sold',):
             raise ValueError("must be one of enum values ('available', 'pending', 'sold')")
         return value
 

diff --git a/.../openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/poop_cleaning.py b/.../openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/poop_cleaning.py
@@ -33,14 +33,14 @@ class PoopCleaning(BaseModel):
     @validator('task_name')
     def task_name_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('cleaning'):
+        if value not in ('cleaning',):
             raise ValueError("must be one of enum values ('cleaning')")
         return value
 
     @validator('function_name')
     def function_name_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('care'):
+        if value not in ('care',):
             raise ValueError("must be one of enum values ('care')")
         return value
 

diff --git a/...s/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/special_name.py b/...s/openapi3/client/petstore/python-pydantic-v1-aiohttp/petstore_api/models/special_name.py
@@ -37,7 +37,7 @@ def var_schema_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in ('available', 'pending', 'sold'):
+        if value not in ('available', 'pending', 'sold',):
             raise ValueError("must be one of enum values ('available', 'pending', 'sold')")
         return value
 

diff --git a/...t/petstore/python-pydantic-v1-aiohttp/petstore_api/models/test_model_with_enum_default.py b/...t/petstore/python-pydantic-v1-aiohttp/petstore_api/models/test_model_with_enum_default.py
@@ -40,7 +40,7 @@ def test_inline_defined_enum_with_default_validate_enum(cls, value):
         if value is None:
             return value
 
-        if value not in ('A', 'B', 'C'):
+        if value not in ('A', 'B', 'C',):
             raise ValueError("must be one of enum values ('A', 'B', 'C')")
         return value
 

diff --git a/samples/openapi3/client/petstore/python-pydantic-v1/docs/EnumTest.md b/samples/openapi3/client/petstore/python-pydantic-v1/docs/EnumTest.md
@@ -11,6 +11,8 @@ Name | Type | Description | Notes
 **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] 

diff --git a/samples/openapi3/client/petstore/python-pydantic-v1/petstore_api/models/bathing.py b/samples/openapi3/client/petstore/python-pydantic-v1/petstore_api/models/bathing.py
@@ -34,14 +34,14 @@ class Bathing(BaseModel):
     @validator('task_name')
     def task_name_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('cleaning_deep'):
+        if value not in ('cleaning_deep',):
             raise ValueError("must be one of enum values ('cleaning_deep')")
         return value
 
     @validator('function_name')
     def function_name_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in ('care_nourish'):
+        if value not in ('care_nourish',):
             raise ValueError("must be one of enum values ('care_nourish')")
         return value