xml.etree.ElementTree: fix missing None in get(), findtext() return type #3093
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
| def findtext(self, path: _str_argument_type, default: Optional[_T] = ..., namespaces: Optional[Dict[_str_argument_type, _str_argument_type]] = ...) -> Union[_T, _str_result_type]: ... | ||
| def get(self, key: _str_argument_type, default: Optional[_T] = ...) -> Union[_str_result_type, _T]: ... | ||
| @overload | ||
| def findtext(self, path: _str_argument_type, namespaces: Optional[Dict[_str_argument_type, _str_argument_type]] = ...) -> Optional[_str_result_type]: ... |
There was a problem hiding this comment.
Shouldn't namespaces be keyword-only in this overload?
There was a problem hiding this comment.
Yes, that's a good idea. Changed.
Before, this code
from xml.etree.ElementTree import Element
reveal_type(Element('foo').findtext('bar'))
would reveal `builtins.str`. This is incorrect because if the path is
not found, a default None is returned.
After, it reveals `Union[builtins.str, None]`.
The solution with `overload`s is the same as used by `Mapping.get` in
`stdlib/3/typing.pyi`.
bluetech
force-pushed
the
xml-findtext-none
branch
from
4599aad to
52fa0fb
Compare
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.
Before, this code
would reveal
builtins.str. This is incorrect because if the path isnot found, a default None is returned.
After, it reveals
Union[builtins.str, None].The solution with
overloads is the same as used byMapping.getinstdlib/3/typing.pyi.