fix: generate enum fields as str/int so raw values pass type checkers#725
Open
Alan4506 wants to merge 2 commits into
Open
fix: generate enum fields as str/int so raw values pass type checkers#725Alan4506 wants to merge 2 commits into
Alan4506 wants to merge 2 commits into
Conversation
This file contains hidden or 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
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 of changes:
When we generate a Python dataclass for a Smithy structure, each member that targets an enum shape gets a type annotation. Before #702, these fields were annotated as
str | None(orint | Nonefor intEnums), so users could pass either a raw string like"RETRIEVAL_MODE"or the enum constantChatMode.RETRIEVAL_MODE: both worked and both passed type checkers.#702 changed
genericEnuminPythonSymbolProviderto return the enum class symbol directly, so those fields becameChatMode | None. This is more precise, but it means passing a raw string (awslabs/aws-sdk-python#54 for example) now fails static type checkers (e.g.,ty) with errors like:This PR restores the original
str/intfield typing while preserving all #702 functionality (error correction, unknown-value handling).Testing:
Regenerated the
qbusinessandconnecthealthclients locally. Verfied their integration tests (awslabs/aws-sdk-python#54 and awslabs/aws-sdk-python#62) still passed, which means the #702 functionality is preserved. Type checkertyalso passed with no issues.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.