Add comment indicating default value of format parameter in typing.get_type_hints()#15268
Merged
JelleZijlstra merged 2 commits intopython:mainfrom Jan 13, 2026
Merged
Conversation
This comment has been minimized.
This comment has been minimized.
srittau
approved these changes
Jan 12, 2026
Collaborator
|
This needs stubtest allowlist entries. |
Member
|
I'd prefer to keep None because that's the actual runtime default, regardless of the motivation. |
Contributor
Author
|
I'd find it a bit unfortunate but I don't have strong opinions. I'm wondering if Or, could we at least have a comment in the stubs stating what is the actual default? |
Collaborator
That sounds like a good compromise to me. |
Member
|
A comment would be fine! |
Viicos
commented
Jan 13, 2026
format parameter in typing.get_type_hints()format parameter in typing.get_type_hints()
JelleZijlstra
approved these changes
Jan 13, 2026
Contributor
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
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.
The runtime definition only has a default of
Noneto lazily importannotationlib: https://github.com/python/cpython/blob/66e1399311c17684c6e26f5d9d9603fbd0717d0d/Lib/typing.py#L2365-L2367.While providing
Noneexplicitly is technically valid, it's best to have the value present in the stub so that users can easily know the default value.