Mark typing.TYPE_CHECKING as Final
#13180
Merged
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
Contributor
|
Diff from mypy_primer, showing the effect of this PR on open source code: sphinx (https://github.com/sphinx-doc/sphinx)
+ sphinx/ext/autodoc/importer.py: note: In function "import_object":
+ sphinx/ext/autodoc/importer.py:182:25: error: Cannot assign to final name "TYPE_CHECKING" [misc]
+ sphinx/ext/autodoc/importer.py:188:25: error: Cannot assign to final name "TYPE_CHECKING" [misc]
|
Contributor
|
It should probably be a literal too? |
srittau
approved these changes
Dec 3, 2024
Collaborator
srittau
left a comment
srittau
left a comment
There was a problem hiding this comment.
I don't think we should make this a literal. This will be special cased by type checkers anyway, but it's unclear whether it should be True or False in the stubs, i.e. whether the stubs should represent runtime or type checking time.
kbaikov
pushed a commit
to kbaikov/typeshed
that referenced
this pull request
Dec 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Per PEP 563,
typing.TYPE_CHECKINGis intended to be a constant. It seems sensible to annotate it as such.(Apparently some projects do modify it (e.g. sphinx autodoc temporarily sets it to
Trueto help with import analysis), but that sort of use case seems dubious/exceptional enough to warrant a# type: ignore.)