fix(parser): type hints should reflect primitive types support#8175
Open
catarinacps wants to merge 1 commit intoaws-powertools:developfrom
Open
fix(parser): type hints should reflect primitive types support#8175catarinacps wants to merge 1 commit intoaws-powertools:developfrom
catarinacps wants to merge 1 commit intoaws-powertools:developfrom
Conversation
As per aws-powertools#4502, primitive types are supported by the `parser` utility. However, the type hints utilized in the functions and envelopes there do not reflect that at the moment, making type checkers lack when inferring the return types, for example. This aims to improve this situation by adjusting the type hints there.
|
Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need. |
powertools-for-aws-oss-automation
Bot
added
the
size/L
|
|
Not all issues are linked correctly. Please link each issue to the PR either manually or using a closing keyword in the format If mentioning more than one issue, separate them with commas: i.e. |
catarinacps
changed the title
catarinacps
changed the title
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
1 participant
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.
Issue number: closes #8174
Summary
As per #4502, primitive types are supported by the
parserutility. However, the type hints utilized in the functions and envelopes there do not reflect that at the moment, making type checkers lack when inferring the return types, for example. This aims to improve this situation by adjusting the type hints there.Changes
This PR thus changes the
TypeVarused in the envelope types' functions toT, introduced in #4502. It also sets theBaseEnvelopeparser(...)method with envelope overload return type hint toT | list[T | None] | Noneto allow those subclasses to overload the method correctly.User experience
Before:
After the change the type checker will be able to narrow the type to
list[EUMMessage], as that is the actual return type that should be shown.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.