Merged
Conversation
Contributor
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
srittau
approved these changes
Oct 29, 2024
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
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.
This would be helpful for red-knot, the work-in-progress type checker we're building at Astral.
To figure out which symbols are available in all modules as "implicit globals", red-knot iterates through the symbols declared in typeshed's stub for
types.ModuleType. Currently the only implicit global that is not declared in the stub fortypes.ModuleTypeis__doc__1; this PR adds it to the stub.While adding
ModuleType.__doc__is somewhat "redundant" from a purist view of the stubs (since it's the same type asobject.__doc__, andModuleTypeinherits fromobject), it's still accurate. We could special-case__doc__in red-knot instead of adding it to the typeshed stubs, but we'd prefer to figure out which attributes exist as implicit globals by inspecting typeshed's stubs and doing the absolute minimum amount of special-casing. This approach means that we'll naturally pick up new implicit globals if they're ever added to the stubs in the future.Footnotes
...Well.
__annotations__is also available as an implicit global in some versions of Python:But not on others:
So it seems like it's probably a bad idea for users to rely on that one being defined as an implicit global. Therefore this PR does not add
ModuleType.__annotations__, onlyModuleType.__doc__. ↩