Adjust SCC setup to enable earlier collections.abc import in typeshed #14088
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
Fixes python#11860 (?) Typeshed is currently unable to import Sequence, MutableSequence, or ByteString from collections.abc within builtins.pyi. It seems this is because: 1. In order to analyze `collections.abc`, we first need to analyze `collections`. 2. Since `collections` is a package containing an `__init__.pyi` file, the `add_implicit_module_attrs` function will try adding the `__path__` variable to the symboltable. 3. The `__path__` variable has type `builtins.str`. But str is a subclass of Sequence, which we have not analyzed yet since we're still in the middle of analyzing `collections` and `collections.abc`. This diff tries repairing this by: 1. Adding `_collections_abc` and `collections.abc` to the set of special-cased core modules we deliberately process early. 2. Modifying `add_implicit_module_attrs` so it does the same trick we do for the `__doc__` symbol and fall back to using an UnboundType if `builtins.str` is not defined yet. To be 100% honest, I'm not really sold on this PR for a few reasons: - I was able to test these changes manually, but wasn't sure how to write tests for them. - We have 3-4 subtly different lists of "core modules" scattered throughout mypy. For example, see `CORE_BUILTIN_MODULES` in mypy/build.py or try grepping for the string `"typing"` in the mypy dir. Arguably, we should defer landing this PR until we've had a chance to consolidate these lists and confirm there are no additional places where we need to special-case `_collections_abc`, `collections`, and `collections.abc`. - PEP 585 attempted to declare that we should one day remove entries like Sequence from `typing` module, but this realistically doesn't seem ever achievable given that (a) it would break backwards compat and (b) there doesn't seem to be any incentives for users to proactively switch. In that case, is there any pressing reason to change typeshed? Regardless, this is a crash and my goal atm is to de-crash mypy, so I'm throwing this over the wall.
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
FWIW, I agree that this is about as low-priority as a crash report can be (and I'm the original filer of the report). It would be nice to be able to be consistent in typeshed, but there's definitely no urgent need to change anything :) |
AlexWaygood
pushed a commit
to AlexWaygood/mypy
that referenced
this pull request
Jan 26, 2023
…python#14088) Fixes python#11860 (?) Typeshed is currently unable to import Sequence, MutableSequence, or ByteString from collections.abc within builtins.pyi. It seems this is because: 1. In order to analyze `collections.abc`, we first need to analyze `collections`. 2. Since `collections` is a package containing an `__init__.pyi` file, the `add_implicit_module_attrs` function will try adding the `__path__` variable to the symboltable. 3. The `__path__` variable has type `builtins.str`. But str is a subclass of Sequence, which we have not analyzed yet since we're still in the middle of analyzing `collections` and `collections.abc`. This diff tries repairing this by: 1. Adding `_collections_abc` and `collections.abc` to the set of special-cased core modules we deliberately process early. 2. Modifying `add_implicit_module_attrs` so it does the same trick we do for the `__doc__` symbol and fall back to using an UnboundType if `builtins.str` is not defined yet. To be 100% honest, I'm not really sold on this PR for a few reasons: - I was able to test these changes manually, but wasn't sure how to write tests for them. - We have 3-4 subtly different lists of "core modules" scattered throughout mypy. For example, see `CORE_BUILTIN_MODULES` in mypy/build.py or try grepping for the string `"typing"` in the mypy dir. Arguably, we should defer landing this PR until we've had a chance to consolidate these lists and confirm there are no additional places where we need to special-case `_collections_abc`, `collections`, and `collections.abc`. - PEP 585 attempted to declare that we should one day remove entries like Sequence from `typing` module, but this realistically doesn't seem ever achievable given that (a) it would break backwards compat and (b) there doesn't seem to be any incentives for users to proactively switch. In that case, is there any pressing reason to change typeshed? Regardless, this is a crash and my goal atm is to de-crash mypy, so I'm throwing this over the wall.
JukkaL
pushed a commit
that referenced
this pull request
Jan 27, 2023
…ort in typeshed (#14531) A backport of #14088 to the `release-1.0` branch. Co-authored-by: Michael Lee <[email protected]>
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.
Fixes #11860 (?)
Typeshed is currently unable to import Sequence, MutableSequence, or ByteString from collections.abc within builtins.pyi. It seems this is because:
In order to analyze
collections.abc, we first need to analyzecollections.Since
collectionsis a package containing an__init__.pyifile, theadd_implicit_module_attrsfunction will try adding the__path__variable to the symboltable.The
__path__variable has typebuiltins.str. But str is a subclass of Sequence, which we have not analyzed yet since we're still in the middle of analyzingcollectionsandcollections.abc.This diff tries repairing this by:
Adding
_collections_abcandcollections.abcto the set of special-cased core modules we deliberately process early.Modifying
add_implicit_module_attrsso it does the same trick we do for the__doc__symbol and fall back to using an UnboundType ifbuiltins.stris not defined yet.To be 100% honest, I'm not really sold on this PR for a few reasons:
CORE_BUILTIN_MODULESin mypy/build.py or try grepping for the string"typing"in the mypy dir. Arguably, we should defer landing this PR until we've had a chance to consolidate these lists and confirm there are no additional places where we need to special-case_collections_abc,collections, andcollections.abc.typingmodule, but this realistically doesn't seem ever achievable given that (a) it would break backwards compat and (b) there doesn't seem to be any incentives for users to proactively switch. In that case, is there any pressing reason to change typeshed?Regardless, this is a crash and my goal atm is to de-crash mypy, so I'm throwing this over the wall.