[ty] Support implicit imports of submodules in __init__.pyi
#20855
+504
−2
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
This is a second take at the implicit imports approach, allowing `from . import submodule` in an `__init__.pyi` to create the `mypackage.submodule` attribute everyhere. This implementation operates inside of the available_submodule_attributes subsystem instead of as a re-export rule. The upside of this is we are no longer purely syntactic, and absolute from imports that happen to target submodules work (an intentional discussed deviation from pyright which demands a relative from import). Also we don't re-export functions or classes. The downside(?) of this is star imports no longer see these attributes (this may be either good or bad. I believe it's not a huge lift to make it work with star imports but it's some non-trivial reworking). I've also intentionally made `import mypackage.submodule` not trigger this rule although it's trivial to change that. I've tried to cover as many relevant cases as possible for discussion in the new test file I've added (there are some random overlaps with existing tests but trying to add them piecemeal felt confusing and weird, so I just made a dedicated file for this extension to the rules). Fixes #133
Gankra
requested review from
AlexWaygood,
MichaReiser,
carljm,
dcreager and
sharkdp
as code owners
Diagnostic diff on typing conformance testsNo changes detected when running ty on typing conformance tests ✅ |
|
CodSpeed Performance ReportMerging #20855 will degrade performances by 11.02%Comparing Summary
Benchmarks breakdown
|
|
AlexWaygood
changed the title
__init__.pyi__init__.pyi
|
| Lint rule | Added | Removed | Changed |
|---|---|---|---|
unresolved-attribute |
0 | 61 | 1 |
invalid-argument-type |
12 | 0 | 0 |
call-non-callable |
3 | 0 | 0 |
possibly-missing-attribute |
1 | 0 | 0 |
| Total | 16 | 61 | 1 |
MichaReiser
reviewed
Oct 14, 2025
Comment on lines
+277
to
+279
| /// The set of modules that are imported anywhere within this file. | ||
| maybe_imported_modules: Arc<FxHashSet<(u32, Option<String>, String)>>, | ||
|
|
There was a problem hiding this comment.
How is this different from imported_modules?
I also suggest using a named struct here. It's non obvious what the semantic meaning of the tuple fields are.
It might be worth using Name instead of String, to reduce the amount of heap allocations (or use ModuleName?)
MichaReiser
reviewed
Oct 14, 2025
| .iter() | ||
| // Throw out the result if the import is not a module (e.g. it's a function/class) | ||
| // So that `from a.b import myfunction` is not considered an import of `a.b` | ||
| .filter(|submodule| self.resolve_submodule(db, submodule).is_some()) |
There was a problem hiding this comment.
Should we move this check into maybe_imported_relative_submodules_of_stub_package, given that maybe_imported_relative_submodules_of_stub_package is cached? Is it worth caching maybe_imported_relative_submodules_of_stub_package?
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 is a second take at the implicit imports approach, allowing
from . import submodulein an__init__.pyito create themypackage.submoduleattribute everyhere.This implementation operates inside of the available_submodule_attributes subsystem instead of as a re-export rule.
The upside of this is we are no longer purely syntactic, and absolute from imports that happen to target submodules work (an intentional discussed deviation from pyright which demands a relative from import). Also we don't re-export functions or classes.
The downside(?) of this is star imports no longer see these attributes (this may be either good or bad. I believe it's not a huge lift to make it work with star imports but it's some non-trivial reworking).
I've also intentionally made
import mypackage.submodulenot trigger this rule although it's trivial to change that.I've tried to cover as many relevant cases as possible for discussion in the new test file I've added (there are some random overlaps with existing tests but trying to add them piecemeal felt confusing and weird, so I just made a dedicated file for this extension to the rules).
Fixes #133
Summary
Test Plan