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: Correctly serialize enum with its value (#18327) #18328

Conversation

BaptisteSaves
Copy link
Contributor

@BaptisteSaves BaptisteSaves commented Apr 8, 2024

Fixes #18327

Add a serialization case when it is an enum to use its value and not its name.

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.1.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.

cc @cbornet @tomplus @krjakbrjak @fa0311 @multani

@BaptisteSaves BaptisteSaves marked this pull request as ready for review April 8, 2024 12:05
@BaptisteSaves
Copy link
Contributor Author

Is there any way to add a test that would run the generated Python code ? (IE a pytest)

@multani
Copy link
Contributor

multani commented Apr 8, 2024

@wing328
Copy link
Member

wing328 commented Apr 9, 2024

@wing328 wing328 added this to the 7.5.0 milestone Apr 9, 2024
@BaptisteSaves BaptisteSaves force-pushed the fix-issue-18327-python-enum-serialization branch 3 times, most recently from 3ce3d78 to 5c6aa61 Compare April 9, 2024 11:03
@BaptisteSaves
Copy link
Contributor Author

@wing328 @multani I added a test ensuring the param is now right.

I have a red build on samples generation but locally ./bin/generate-samples.sh does not produce any changes. Do you know how to fix it ?

@wing328
Copy link
Member

wing328 commented Apr 9, 2024

please ignore https://github.com/OpenAPITools/openapi-generator/actions/runs/8614615152/job/23608628515?pr=18328 for the time being.

i'll take a look

update: fixed in the latest master

@@ -358,6 +358,8 @@ class ApiClient:
"""
if obj is None:
return None
elif isinstance(obj, Enum):
return obj.value
Copy link
Member

Choose a reason for hiding this comment

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

would it be possible to write a unit test for sanitize_for_serialization with enum ?

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@BaptisteSaves BaptisteSaves force-pushed the fix-issue-18327-python-enum-serialization branch 3 times, most recently from f741fc7 to cea69ce Compare April 9, 2024 15:06
@BaptisteSaves BaptisteSaves requested a review from wing328 April 9, 2024 15:07
@BaptisteSaves BaptisteSaves force-pushed the fix-issue-18327-python-enum-serialization branch from cea69ce to 7309537 Compare April 9, 2024 16:38
Copy link
Contributor

@fa0311 fa0311 left a comment

Choose a reason for hiding this comment

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

LGTM! thanks!

@BaptisteSaves BaptisteSaves force-pushed the fix-issue-18327-python-enum-serialization branch from 7309537 to ef86851 Compare April 10, 2024 11:55
@wing328 wing328 merged commit 6bcc28d into OpenAPITools:master Apr 10, 2024
44 checks passed
@BaptisteSaves BaptisteSaves deleted the fix-issue-18327-python-enum-serialization branch April 10, 2024 14:02
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.

[BUG][PYTHON] Int Enum serialization is the enum name instead of value
4 participants