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.

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

python-pydantic-v1: Return the primitive type in to_dict for anyOf models #19488

Merged
merged 5 commits into from
Sep 13, 2024

Conversation

chiragjn
Copy link
Contributor

@chiragjn chiragjn commented Aug 30, 2024

Python pydantic definitions for models with multiple schemas using anyOf implement to_dict incorrectly when one of the types is not a pydantic BaseModel.
The function should just return the type as is instead of json dumping it

I don't know if this is considered a breaking change

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
    @fa0311 @multani

@chiragjn chiragjn changed the title python: Return the primitive type in to_dict for anyOf models python-pydantic-v1: Return the primitive type in to_dict for anyOf models Aug 30, 2024
@chiragjn
Copy link
Contributor Author

chiragjn commented Sep 2, 2024

Adding @cbornet @tomplus @krjakbrjak

Requesting a review

@chiragjn
Copy link
Contributor Author

chiragjn commented Sep 9, 2024

@multani Would appreciate a review on this.

Currently this serialization bug is preventing me from using the pydantic v1 generator.

@multani
Copy link
Contributor

multani commented Sep 9, 2024

@chiragjn Could you provide a test to exercise this code and prevent further regressions in the future?

@multani
Copy link
Contributor

multani commented Sep 9, 2024

This file (or the whole folder actually) contains hand-written tests for such a case: https://github.com/OpenAPITools/openapi-generator/blob/master/samples/openapi3/client/petstore/python-pydantic-v1/tests/test_model.py (there's a similar folder for the asyncio generator)

It would be great it you could extend this test suite to show how the issue is fixed by this change. Thanks!


# test to_dict, schema 3
p = petstore_api.AnyOfColor(actual_instance='#123456')
self.assertEqual(p.to_dict(), '#123456')
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before this change, this would render as '"#123456"'

which is incorrect for to_dict

@chiragjn
Copy link
Contributor Author

@multani Updated test, hope this helps

Copy link
Contributor

@multani multani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, @wing328 can you check?

@multani
Copy link
Contributor

multani commented Sep 11, 2024

Thanks for the added tests @chiragjn !

@chiragjn
Copy link
Contributor Author

Sorry for being annoying, Bumping this again to @wing328
Hoping this can land so I can start using this generator soon

@wing328 wing328 added this to the 7.9.0 milestone Sep 13, 2024
@wing328 wing328 merged commit 740b971 into OpenAPITools:master Sep 13, 2024
23 checks passed
@wing328
Copy link
Member

wing328 commented Sep 13, 2024

@chiragjn just merged the PR. Thanks again for your contributions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants