fix: support dash in property names (Pydantic generator) #1955
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for modelina canceled.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
ahem
changed the title
ahem
requested review from
magicmatatjahu,
jonaslagoni,
kennethaasan and
asyncapi-bot-eve
as code owners
This enables the generated models for Pydantic to work for properties with dashes in the name. The generated code now puts descriptions in the "description" argument of the Pydantic Field decorator, and puts the original, unconstrained, property name in the "alias" field. This is correct usage as per the [Pydantic documentation](https://docs.pydantic.dev/latest/concepts/fields/#field-aliases) Also, dashes are allowed through in property key constrainer, so that a property name like "content-type" is converted into "contentType" instead of "contentMinusType".
ahem
force-pushed
the
pydantic-support-dash-in-property-names
branch
from
9610ee2
to
44c4ae5
Compare
|
Pull Request Test Coverage Report for Build 8797818240Details
💛 - Coveralls |
|
/rtm |
|
@all-contributors please add @ahem for code, test, bug |
|
I've put up a pull request to add @ahem! 🎉 |
|
🎉 This PR is included in version 3.4.9 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 4.0.0-next.36 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This enables the generated models for Pydantic to work for properties with dashes in the name.
The generated code now puts descriptions in the "description" argument of the Pydantic Field decorator, and puts the original, unconstrained, property name in the "alias" field. This is correct usage as per the Pydantic documentation
Also, dashes are allowed through in property key constrainer, so that a property name like "content-type" is converted into "contentType" instead of "contentMinusType".
Related Issue
I believe this fixes #1058 but apparently that has been closed with a fix to an mostly unrelated problem.
Checklist
npm run lint).npm run test).Additional Notes
With these changes the generated Pydantic model class can correctly deserialise and serialise the JSON object described by the schema in the updated generate-python-pydantic-models test:
{ "requiredField": "[email protected]", "noDescription": "test", "options": 123, "content-type": "application/json" }Without this change Pydantic would ignore the
"content-type"field since it would not know to map that to the modelscontentTypeproperty.Note that this is technically a breaking change, since before users could use the "description" field in the JSON schema to set the "alias" field on the Pydantic model. This would be a misuse of the description field, though, since it is to decorate a user interface with information about the data produced by this user interface.