Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix: add serialization alias for Pydantic #1859

Merged
merged 1 commit into from Mar 6, 2024
Merged

fix: add serialization alias for Pydantic #1859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions examples/generate-python-pydantic-models/__snapshots__/index.spec.ts.snap
View file
Open in desktop
Expand Up @@ -3,10 +3,10 @@
exports[`Should be able to render python models and should log expected output to console: class-model 1`] = `
Array [
"class Root(BaseModel):
optionalField: Optional[str] = Field(description='''this field is optional''', default=None)
requiredField: str = Field(description='''this field is required''')
noDescription: Optional[str] = Field(default=None)
options: Optional[Options] = Field(default=None)
optionalField: Optional[str] = Field(description='''this field is optional''', default=None, serialization_alias='optionalField')
requiredField: str = Field(description='''this field is required''', serialization_alias='requiredField')
noDescription: Optional[str] = Field(default=None, serialization_alias='noDescription')
options: Optional[Options] = Field(default=None, serialization_alias='options')
",
]
`;
Expand Down
16 changes: 7 additions & 9 deletions src/generators/python/presets/Pydantic.ts
View file
Open in desktop
Expand Up @@ -35,15 +35,13 @@ const PYTHON_PYDANTIC_CLASS_PRESET: ClassPresetType<PythonOptions> = {

const description = params.property.property.originalInput['description']
? `description='''${params.property.property.originalInput['description']}'''`
: '';
const defaultValue = params.property.required ? '' : 'default=None';

if (description && defaultValue) {
return `${propertyName}: ${type} = Field(${description}, ${defaultValue})`;
} else if (description) {
return `${propertyName}: ${type} = Field(${description})`;
}
return `${propertyName}: ${type} = Field(${defaultValue})`;
: undefined;
const defaultValue = params.property.required ? undefined : 'default=None';
const jsonAlias = `serialization_alias='${params.property.unconstrainedPropertyName}'`;
const fieldTags = [description, defaultValue, jsonAlias].filter(
(value) => value
);
return `${propertyName}: ${type} = Field(${fieldTags.join(', ')})`;
},
ctor: () => '',
getter: () => '',
Expand Down
16 changes: 8 additions & 8 deletions test/generators/python/presets/__snapshots__/Pydantic.spec.ts.snap
View file
Open in desktop
Expand Up @@ -5,24 +5,24 @@ exports[`PYTHON_PYDANTIC_PRESET should render pydantic for class 1`] = `
prop: Optional[str] = Field(description='''test
multi
line
description''', default=None)
additionalProperties: Optional[dict[Any, Any]] = Field(default=None)
description''', default=None, serialization_alias='prop')
additionalProperties: Optional[dict[Any, Any]] = Field(default=None, serialization_alias='additionalProperties')
"
`;

exports[`PYTHON_PYDANTIC_PRESET should render union to support Python < 3.10 1`] = `
Array [
"class UnionTest(BaseModel):
unionTest: Optional[Union[Union1, Union2]] = Field(default=None)
additionalProperties: Optional[dict[Any, Any]] = Field(default=None)
unionTest: Optional[Union[Union1, Union2]] = Field(default=None, serialization_alias='unionTest')
additionalProperties: Optional[dict[Any, Any]] = Field(default=None, serialization_alias='additionalProperties')
",
"class Union1(BaseModel):
testProp1: Optional[str] = Field(default=None)
additionalProperties: Optional[dict[Any, Any]] = Field(default=None)
testProp1: Optional[str] = Field(default=None, serialization_alias='testProp1')
additionalProperties: Optional[dict[Any, Any]] = Field(default=None, serialization_alias='additionalProperties')
",
"class Union2(BaseModel):
testProp2: Optional[str] = Field(default=None)
additionalProperties: Optional[dict[Any, Any]] = Field(default=None)
testProp2: Optional[str] = Field(default=None, serialization_alias='testProp2')
additionalProperties: Optional[dict[Any, Any]] = Field(default=None, serialization_alias='additionalProperties')
",
]
`;