Mark PYI025 fix as safe in more cases for stub files#10547
Merged
AlexWaygood merged 1 commit intomainfrom Mar 24, 2024
Merged
Conversation
Member
Author
Contributor
|
charliermarsh
approved these changes
Mar 24, 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
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.
Summary
The fix for PYI025 is currently marked as unsafe in non-global scopes for both
.pyand.pyifiles, on the grounds that all global-scope symbols in Python are implicitly exported from the module, so changing the name of something in the global scope could break other modules that import the module we're fixing. Unlike in.pyfiles, however, imported symbols are never implicitly re-exported from stub files. Symbols are only understood by static analysis tools as being re-exported from stubs if they are marked as explicit re-exports, which take three forms:This is specc'd in PEP 484, and means that we can mark the fix for PYI025 as safe in more cases for
.pyifiles.Test Plan
cargo test. An existing test case goes from being an unsafe fix to a safe fix in a.pyifixture. I also added a new fixture so we have coverage of global-scope imports that are marked as re-exports using "redundant"from collections.abc import Set as Setaliases.