Python SDK safe enum deserialization #282
Merged
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
Prior to this change python SDK would raise when the API returned an invalid enum value. Given an enum type of `MyAPIEnum` and an invalid value of `""` this error would be raised `ValueError: '' is not a valid MyAPIEnum` Now it will deserialize to `MyAPIEnum.invalid_api_enum_value` Side note: I really wanted to but was unable to dynamically modify the `MyAPIEnum.invalid_api_enum_value` enum member value to be the actual invalid value returned by the API. So `MyAPIEnum.invalid_api_enum_value.value` will always be `"invalid_api_enum_value"`
joeldodge79
commented
Jul 30, 2020
There was a problem hiding this comment.
@jkaster I don't know if kotlin or any other language that raises on bad enum values has a similar solution but I thought I'd put this one up for python.
Comment on lines
+137
to
+139
| "@typescript-eslint/no-unused-vars": [ | ||
| "warn", {"args": "all", "argsIgnorePattern": "^_"} | ||
| ], |
There was a problem hiding this comment.
I was seeing Warning: eslint: '_indent' is defined but never used. for things like streamsPrologue(_indent: string).
There was a problem hiding this comment.
yeah we need to tweak eslint settings as you did. Thanks!
There was a problem hiding this comment.
We needed this in APIX too. Thanks for fixing.
jkaster
approved these changes
Jul 30, 2020
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.
Prior to this change python SDK would raise when the API returned an
invalid enum value. Given an enum type of
MyAPIEnumand an invalidvalue of
""this error would be raisedValueError: '' is not a valid MyAPIEnumNow it will deserialize to
MyAPIEnum.invalid_api_enum_valueSide note: I really wanted to but was unable to dynamically modify the
MyAPIEnum.invalid_api_enum_valueenum member value to be the actualinvalid value returned by the API. So
MyAPIEnum.invalid_api_enum_value.valuewill always be"invalid_api_enum_value"