Skip to content

Specify named param for field defaults in Python Pydantic V1 generator #18187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -956,7 +956,7 @@ private ModelsMap postProcessModelsMap(ModelsMap objs) {
}

if (!fields.isEmpty()) {
fields.add(0, fieldCustomization);
fields.add(0, "default=" + fieldCustomization);
pydanticImports.add("Field");
fieldCustomization = String.format(Locale.ROOT, "Field(%s)", StringUtils.join(fields, ", "));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated

from pydantic import StrictStr

from openapi_client.api_client import ApiClient, RequestSerialized
from openapi_client.api_response import ApiResponse
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ class DataQuery(Query):
"""
DataQuery
"""
suffix: Optional[StrictStr] = Field(None, description="test suffix")
text: Optional[StrictStr] = Field(None, description="Some text containing white spaces")
var_date: Optional[datetime] = Field(None, alias="date", description="A date")
suffix: Optional[StrictStr] = Field(default=None, description="test suffix")
text: Optional[StrictStr] = Field(default=None, description="Some text containing white spaces")
var_date: Optional[datetime] = Field(default=None, alias="date", description="A date")
__properties = ["id", "outcomes", "suffix", "text", "date"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ class Pet(BaseModel):
id: Optional[StrictInt] = None
name: StrictStr = Field(...)
category: Optional[Category] = None
photo_urls: conlist(StrictStr) = Field(..., alias="photoUrls")
photo_urls: conlist(StrictStr) = Field(default=..., alias="photoUrls")
tags: Optional[conlist(Tag)] = None
status: Optional[StrictStr] = Field(None, description="pet status in the store")
status: Optional[StrictStr] = Field(default=None, description="pet status in the store")
__properties = ["id", "name", "category", "photoUrls", "tags", "status"]

@validator('status')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class Query(BaseModel):
"""
Query
"""
id: Optional[StrictInt] = Field(None, description="Query")
id: Optional[StrictInt] = Field(default=None, description="Query")
outcomes: Optional[conlist(StrictStr)] = None
__properties = ["id", "outcomes"]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated

from pydantic import StrictStr

from openapi_client.api_client import ApiClient, RequestSerialized
from openapi_client.api_response import ApiResponse
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated

from pydantic import Field, StrictStr
from pydantic import Field, StrictInt, StrictStr
from typing import Dict
from typing_extensions import Annotated
from petstore_api.models.order import Order

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class AllOfWithSingleRef(BaseModel):
AllOfWithSingleRef
"""
username: Optional[StrictStr] = None
single_ref_type: Optional[SingleRefType] = Field(None, alias="SingleRefType")
single_ref_type: Optional[SingleRefType] = Field(default=None, alias="SingleRefType")
__properties = ["username", "SingleRefType"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class Animal(BaseModel):
"""
Animal
"""
class_name: StrictStr = Field(..., alias="className")
class_name: StrictStr = Field(default=..., alias="className")
color: Optional[StrictStr] = 'red'
__properties = ["className", "color"]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ class AnyOfColor(BaseModel):
"""

# data type: List[int]
anyof_schema_1_validator: Optional[conlist(conint(strict=True, le=255, ge=0), max_items=3, min_items=3)] = Field(None, description="RGB three element array with values 0-255.")
anyof_schema_1_validator: Optional[conlist(conint(strict=True, le=255, ge=0), max_items=3, min_items=3)] = Field(default=None, description="RGB three element array with values 0-255.")
# data type: List[int]
anyof_schema_2_validator: Optional[conlist(conint(strict=True, le=255, ge=0), max_items=4, min_items=4)] = Field(None, description="RGBA four element array with values 0-255.")
anyof_schema_2_validator: Optional[conlist(conint(strict=True, le=255, ge=0), max_items=4, min_items=4)] = Field(default=None, description="RGBA four element array with values 0-255.")
# data type: str
anyof_schema_3_validator: Optional[constr(strict=True, max_length=7, min_length=7)] = Field(None, description="Hex color string, such as #00FF00.")
anyof_schema_3_validator: Optional[constr(strict=True, max_length=7, min_length=7)] = Field(default=None, description="Hex color string, such as #00FF00.")
if TYPE_CHECKING:
actual_instance: Union[List[int], str]
else:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class ArrayOfArrayOfNumberOnly(BaseModel):
"""
ArrayOfArrayOfNumberOnly
"""
array_array_number: Optional[conlist(conlist(float))] = Field(None, alias="ArrayArrayNumber")
array_array_number: Optional[conlist(conlist(float))] = Field(default=None, alias="ArrayArrayNumber")
__properties = ["ArrayArrayNumber"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class ArrayOfNumberOnly(BaseModel):
"""
ArrayOfNumberOnly
"""
array_number: Optional[conlist(float)] = Field(None, alias="ArrayNumber")
array_number: Optional[conlist(float)] = Field(default=None, alias="ArrayNumber")
__properties = ["ArrayNumber"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class BasquePig(BaseModel):
"""
BasquePig
"""
class_name: StrictStr = Field(..., alias="className")
class_name: StrictStr = Field(default=..., alias="className")
color: StrictStr = Field(...)
__properties = ["className", "color"]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ class Capitalization(BaseModel):
"""
Capitalization
"""
small_camel: Optional[StrictStr] = Field(None, alias="smallCamel")
capital_camel: Optional[StrictStr] = Field(None, alias="CapitalCamel")
small_snake: Optional[StrictStr] = Field(None, alias="small_Snake")
capital_snake: Optional[StrictStr] = Field(None, alias="Capital_Snake")
sca_eth_flow_points: Optional[StrictStr] = Field(None, alias="SCA_ETH_Flow_Points")
att_name: Optional[StrictStr] = Field(None, alias="ATT_NAME", description="Name of the pet ")
small_camel: Optional[StrictStr] = Field(default=None, alias="smallCamel")
capital_camel: Optional[StrictStr] = Field(default=None, alias="CapitalCamel")
small_snake: Optional[StrictStr] = Field(default=None, alias="small_Snake")
capital_snake: Optional[StrictStr] = Field(default=None, alias="Capital_Snake")
sca_eth_flow_points: Optional[StrictStr] = Field(default=None, alias="SCA_ETH_Flow_Points")
att_name: Optional[StrictStr] = Field(default=None, alias="ATT_NAME", description="Name of the pet ")
__properties = ["smallCamel", "CapitalCamel", "small_Snake", "Capital_Snake", "SCA_ETH_Flow_Points", "ATT_NAME"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class ClassModel(BaseModel):
"""
Model for testing model with \"_class\" property # noqa: E501
"""
var_class: Optional[StrictStr] = Field(None, alias="_class")
var_class: Optional[StrictStr] = Field(default=None, alias="_class")
__properties = ["_class"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ class Color(BaseModel):
RGB array, RGBA array, or hex string.
"""
# data type: List[int]
oneof_schema_1_validator: Optional[conlist(conint(strict=True, le=255, ge=0), max_items=3, min_items=3)] = Field(None, description="RGB three element array with values 0-255.")
oneof_schema_1_validator: Optional[conlist(conint(strict=True, le=255, ge=0), max_items=3, min_items=3)] = Field(default=None, description="RGB three element array with values 0-255.")
# data type: List[int]
oneof_schema_2_validator: Optional[conlist(conint(strict=True, le=255, ge=0), max_items=4, min_items=4)] = Field(None, description="RGBA four element array with values 0-255.")
oneof_schema_2_validator: Optional[conlist(conint(strict=True, le=255, ge=0), max_items=4, min_items=4)] = Field(default=None, description="RGBA four element array with values 0-255.")
# data type: str
oneof_schema_3_validator: Optional[constr(strict=True, max_length=7, min_length=7)] = Field(None, description="Hex color string, such as #00FF00.")
oneof_schema_3_validator: Optional[constr(strict=True, max_length=7, min_length=7)] = Field(default=None, description="Hex color string, such as #00FF00.")
if TYPE_CHECKING:
actual_instance: Union[List[int], str]
else:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class DanishPig(BaseModel):
"""
DanishPig
"""
class_name: StrictStr = Field(..., alias="className")
class_name: StrictStr = Field(default=..., alias="className")
size: StrictInt = Field(...)
__properties = ["className", "size"]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class DiscriminatorAllOfSuper(BaseModel):
"""
DiscriminatorAllOfSuper
"""
element_type: StrictStr = Field(..., alias="elementType")
element_type: StrictStr = Field(default=..., alias="elementType")
__properties = ["elementType"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ class EnumTest(BaseModel):
enum_integer_default: Optional[StrictInt] = 5
enum_integer: Optional[StrictInt] = None
enum_number: Optional[float] = None
outer_enum: Optional[OuterEnum] = Field(None, alias="outerEnum")
outer_enum_integer: Optional[OuterEnumInteger] = Field(None, alias="outerEnumInteger")
outer_enum_default_value: Optional[OuterEnumDefaultValue] = Field(None, alias="outerEnumDefaultValue")
outer_enum_integer_default_value: Optional[OuterEnumIntegerDefaultValue] = Field(None, alias="outerEnumIntegerDefaultValue")
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", "outerEnum", "outerEnumInteger", "outerEnumDefaultValue", "outerEnumIntegerDefaultValue"]

@validator('enum_string')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class File(BaseModel):
"""
Must be named `File` for test. # noqa: E501
"""
source_uri: Optional[StrictStr] = Field(None, alias="sourceURI", description="Test capitalization")
source_uri: Optional[StrictStr] = Field(default=None, alias="sourceURI", description="Test capitalization")
__properties = ["sourceURI"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ class FormatTest(BaseModel):
string_with_double_quote_pattern: Optional[constr(strict=True)] = None
byte: Optional[Union[StrictBytes, StrictStr]] = None
binary: Optional[Union[StrictBytes, StrictStr]] = None
var_date: date = Field(..., alias="date")
date_time: Optional[datetime] = Field(None, alias="dateTime")
var_date: date = Field(default=..., alias="date")
date_time: Optional[datetime] = Field(default=None, alias="dateTime")
uuid: Optional[StrictStr] = None
password: constr(strict=True, max_length=64, min_length=10) = Field(...)
pattern_with_digits: Optional[constr(strict=True)] = Field(None, description="A string that is a 10 digit number. Can have leading zeros.")
pattern_with_digits_and_delimiter: Optional[constr(strict=True)] = Field(None, description="A string starting with 'image_' (case insensitive) and one to three digits following i.e. Image_01.")
pattern_with_digits: Optional[constr(strict=True)] = Field(default=None, description="A string that is a 10 digit number. Can have leading zeros.")
pattern_with_digits_and_delimiter: Optional[constr(strict=True)] = Field(default=None, description="A string starting with 'image_' (case insensitive) and one to three digits following i.e. Image_01.")
__properties = ["integer", "int32", "int64", "number", "float", "double", "decimal", "string", "string_with_double_quote_pattern", "byte", "binary", "date", "dateTime", "uuid", "password", "pattern_with_digits", "pattern_with_digits_and_delimiter"]

@validator('string')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class HealthCheckResult(BaseModel):
"""
Just a string to inform instance is up and running. Make it nullable in hope to get it as pointer in generated model. # noqa: E501
"""
nullable_message: Optional[StrictStr] = Field(None, alias="NullableMessage")
nullable_message: Optional[StrictStr] = Field(default=None, alias="NullableMessage")
__properties = ["NullableMessage"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class InnerDictWithProperty(BaseModel):
"""
InnerDictWithProperty
"""
a_property: Optional[Dict[str, Any]] = Field(None, alias="aProperty")
a_property: Optional[Dict[str, Any]] = Field(default=None, alias="aProperty")
__properties = ["aProperty"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class ListClass(BaseModel):
"""
ListClass
"""
var_123_list: Optional[StrictStr] = Field(None, alias="123-list")
var_123_list: Optional[StrictStr] = Field(default=None, alias="123-list")
__properties = ["123-list"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class MapOfArrayOfModel(BaseModel):
"""
MapOfArrayOfModel
"""
shop_id_to_org_online_lip_map: Optional[Dict[str, conlist(Tag)]] = Field(None, alias="shopIdToOrgOnlineLipMap")
shop_id_to_org_online_lip_map: Optional[Dict[str, conlist(Tag)]] = Field(default=None, alias="shopIdToOrgOnlineLipMap")
__properties = ["shopIdToOrgOnlineLipMap"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class MixedPropertiesAndAdditionalPropertiesClass(BaseModel):
MixedPropertiesAndAdditionalPropertiesClass
"""
uuid: Optional[StrictStr] = None
date_time: Optional[datetime] = Field(None, alias="dateTime")
date_time: Optional[datetime] = Field(default=None, alias="dateTime")
map: Optional[Dict[str, Animal]] = None
__properties = ["uuid", "dateTime", "map"]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class Model200Response(BaseModel):
Model for testing model name starting with number # noqa: E501
"""
name: Optional[StrictInt] = None
var_class: Optional[StrictStr] = Field(None, alias="class")
var_class: Optional[StrictStr] = Field(default=None, alias="class")
__properties = ["name", "class"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class ModelReturn(BaseModel):
"""
Model for testing reserved words # noqa: E501
"""
var_return: Optional[StrictInt] = Field(None, alias="return")
var_return: Optional[StrictInt] = Field(default=None, alias="return")
__properties = ["return"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ class Name(BaseModel):
"""
name: StrictInt = Field(...)
snake_case: Optional[StrictInt] = None
var_property: Optional[StrictStr] = Field(None, alias="property")
var_123_number: Optional[StrictInt] = Field(None, alias="123Number")
var_property: Optional[StrictStr] = Field(default=None, alias="property")
var_123_number: Optional[StrictInt] = Field(default=None, alias="123Number")
__properties = ["name", "snake_case", "property", "123Number"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class NumberOnly(BaseModel):
"""
NumberOnly
"""
just_number: Optional[float] = Field(None, alias="JustNumber")
just_number: Optional[float] = Field(default=None, alias="JustNumber")
__properties = ["JustNumber"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class ObjectToTestAdditionalProperties(BaseModel):
"""
Minimal object # noqa: E501
"""
var_property: Optional[StrictBool] = Field(False, alias="property", description="Property")
var_property: Optional[StrictBool] = Field(default=False, alias="property", description="Property")
__properties = ["property"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class ObjectWithDeprecatedFields(BaseModel):
"""
uuid: Optional[StrictStr] = None
id: Optional[float] = None
deprecated_ref: Optional[DeprecatedObject] = Field(None, alias="deprecatedRef")
deprecated_ref: Optional[DeprecatedObject] = Field(default=None, alias="deprecatedRef")
bars: Optional[conlist(StrictStr)] = None
__properties = ["uuid", "id", "deprecatedRef", "bars"]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ class Order(BaseModel):
Order
"""
id: Optional[StrictInt] = None
pet_id: Optional[StrictInt] = Field(None, alias="petId")
pet_id: Optional[StrictInt] = Field(default=None, alias="petId")
quantity: Optional[StrictInt] = None
ship_date: Optional[datetime] = Field(None, alias="shipDate")
status: Optional[StrictStr] = Field(None, description="Order Status")
ship_date: Optional[datetime] = Field(default=None, alias="shipDate")
status: Optional[StrictStr] = Field(default=None, description="Order Status")
complete: Optional[StrictBool] = False
__properties = ["id", "petId", "quantity", "shipDate", "status", "complete"]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class Parent(BaseModel):
"""
Parent
"""
optional_dict: Optional[Dict[str, InnerDictWithProperty]] = Field(None, alias="optionalDict")
optional_dict: Optional[Dict[str, InnerDictWithProperty]] = Field(default=None, alias="optionalDict")
__properties = ["optionalDict"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class ParentWithOptionalDict(BaseModel):
"""
ParentWithOptionalDict
"""
optional_dict: Optional[Dict[str, InnerDictWithProperty]] = Field(None, alias="optionalDict")
optional_dict: Optional[Dict[str, InnerDictWithProperty]] = Field(default=None, alias="optionalDict")
__properties = ["optionalDict"]

class Config:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ class Pet(BaseModel):
id: Optional[StrictInt] = None
category: Optional[Category] = None
name: StrictStr = Field(...)
photo_urls: conlist(StrictStr, min_items=0, unique_items=True) = Field(..., alias="photoUrls")
photo_urls: conlist(StrictStr, min_items=0, unique_items=True) = Field(default=..., alias="photoUrls")
tags: Optional[conlist(Tag)] = None
status: Optional[StrictStr] = Field(None, description="pet status in the store")
status: Optional[StrictStr] = Field(default=None, description="pet status in the store")
__properties = ["id", "category", "name", "photoUrls", "tags", "status"]

@validator('status')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class PropertyNameCollision(BaseModel):
"""
PropertyNameCollision
"""
type: Optional[StrictStr] = Field(None, alias="_type")
type: Optional[StrictStr] = Field(default=None, alias="_type")
type: Optional[StrictStr] = None
type_: Optional[StrictStr] = None
__properties = ["_type", "type", "type_"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class SpecialModelName(BaseModel):
"""
SpecialModelName
"""
special_property_name: Optional[StrictInt] = Field(None, alias="$special[property.name]")
special_property_name: Optional[StrictInt] = Field(default=None, alias="$special[property.name]")
__properties = ["$special[property.name]"]

class Config:
Expand Down
Loading
Loading