Stub generation and module re-exports, #noqa
还没有人认领这个 Issue。
评估
调研方向
Start by locating stubgen's handling of wildcard and explicit imports, then review any existing tests for generated re-exports. The issue presents three unresolved policy options, so agree on the intended behavior first. Done means the chosen policy is implemented and covered by a regression test for explicit re-exports such as the Django example.
由索引模型根据 Issue 内容生成。
描述
Many larger libraries break up their packages into multiple modules, then "re-export" the modules in the package's __init__.py
For example, in django.db.models:
from django.db.models.fields import * # NOQA
from django.db.models.fields.files import FileField, ImageField # NOQA
This allows you to import FileField and CharField (from django.db.models.fields) directly from django.db.models
stubgen currently provides these re-exports in the case of import *, but not in the second import. So FileField is missing from the django.db.models stub.
This makes sense, since all imports are re-exports, but that might not be the wanted API (should I really be importing requests from some random module in the middle of my application? probably not). But, of course, sometimes it's on purpose.
This does come up a lot, though, so I was thinking of 3 possible solutions:
- Re-export all imports when doing stub generation
This will cause generated stubs to best represent reality. This solution will make initial annotations easier, but also makes the output messier than what authors might want their public API to look like. - Re-export "unused" imports.
This is tricky because intent is hard to decipher. Indjango's case, unused imports (with# noqa) are almost certainly meant for re-exporting. We could look for such comments on import lines, or figure out some other kind of heuristic. - Do nothing
This issue comes up with big libraries, but not so much in application code. Big libraries usually have enough people to power through this sort of thing.
I tried looking in the issues and didn't see this coming up, but the easier the stub generation output is, the more likely people will get the third party annotation work done, so it would be cool to get this right. I think the second one is reasonable, first one is the easiest to implement.
- 主要语言
- Python
- 星标
- 20.6k
- 派生
- 3.3k
- 平均合并
- 1 天 18 小时
- 30 天内合并 PR
- 54
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
python/mypy 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
-
bug
难度 2/5 1-3 小时 新手友好度 76/100
-
documentation
难度 2/5 1-3 小时 新手友好度 72/100
-
bug topic-configuration topic-error-reporting
难度 2/5 1-3 小时 新手友好度 68/100
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 90/100
-
bug
难度 2/5 1-3 小时 新手友好度 86/100
zostera/django-bootstrap4#894 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
use-agent-os/agent-os#3276 ·
-
难度 2/5 1-3 小时 新手友好度 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
难度 2/5 1-3 小时 新手友好度 88/100
NousResearch/hermes-agent#117848 ·