stubgen generates stubs for `@asynccontextmanager` functions that mypy itself rejects
还没有人认领这个 Issue。
评估
调研方向
从 stubgen 的入口点开始,使用报告中的 @asynccontextmanager 示例通过 cm.py 重现该问题。比较为异步生成器函数和方法生成的 .pyi 输出,然后对生成的 stub 运行 mypy。完成标准是:针对这一情况生成的 stub 在保留预期的上下文管理器类型的同时,能够无错误地通过类型检查。
由索引模型根据 Issue 内容生成。
描述
Bug Report
stubgen copies @asynccontextmanager and the async def keyword verbatim into the generated .pyi. Because a stub body has no yield, mypy then classifies the stubbed function as a coroutine function returning AsyncIterator[T] rather than as an async generator function, and rejects the decorator application.
The result is that stubgen emits a stub which mypy — the same version, with default settings — reports an error on. Source that type-checks cleanly produces a stub that does not.
To Reproduce
# cm.py
from collections.abc import AsyncIterator
from contextlib import asynccontextmanager
@asynccontextmanager
async def ctx() -> AsyncIterator[int]:
yield 1
$ mypy cm.py
Success: no issues found in 1 source file
$ stubgen -o out cm.py
Processed 1 modules
Generated out/cm.pyi
$ cat out/cm.pyi
from collections.abc import AsyncIterator
from contextlib import asynccontextmanager
@asynccontextmanager
async def ctx() -> AsyncIterator[int]: ...
$ mypy out/cm.pyi
out/cm.pyi:4: error: Argument 1 to "asynccontextmanager" has incompatible type "Callable[[], Coroutine[Any, Any, AsyncIterator[int]]]"; expected "Callable[[], AsyncIterator[Never]]" [arg-type]
Found 1 error in 1 file (checked 1 source file)
The same happens for methods, and with AsyncGenerator[T, None] in place of AsyncIterator[T].
Expected Behavior
stubgen output should type-check under the mypy version that produced it. For an @asynccontextmanager-decorated async generator, that means emitting one of the two spellings the typing docs sanction for stubs — either dropping async:
@asynccontextmanager
def ctx() -> AsyncIterator[int]: ...
or dropping the decorator and declaring the decorated result, as typeshed does:
from contextlib import AbstractAsyncContextManager
def ctx() -> AbstractAsyncContextManager[int]: ...
Both of these are accepted by mypy 2.3.0.
Actual Behavior
out/cm.pyi:4: error: Argument 1 to "asynccontextmanager" has incompatible type "Callable[[], Coroutine[Any, Any, AsyncIterator[int]]]"; expected "Callable[[], AsyncIterator[Never]]" [arg-type]
Your Environment
- Mypy version used: 2.3.0 (compiled: yes)
- Mypy command-line flags: none (
mypy out/cm.pyi); stub produced withstubgen -o out cm.py - Mypy configuration options from
mypy.ini(and other config files): none - Python version used: 3.11.15
Additional notes
This is a change in behaviour from 1.15.0. That version's stubgen omitted the decorator entirely:
# stubgen 1.15.0
async def ctx() -> AsyncIterator[int]: ...
which is also lossy, but happens to type-check, so the problem only becomes visible on 2.3.0 once the decorator is preserved.
The synchronous case is unaffected — @contextmanager over def f() -> Iterator[T] round-trips through stubgen and type-checks on 2.3.0, because there is no async keyword to change how the return type is interpreted.
- 主要语言
- Python
- 星标
- 20.6k
- 派生
- 3.3k
- 平均合并
- 1 天 3 小时
- 30 天内合并 PR
- 59
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
python/mypy 的其他 Issue
-
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
-
bug topic-attrs
难度 2/5 1-3 小时 新手友好度 62/100
相似的 Issue
-
area: harness bug status: needs-triage
难度 2/5 1-3 小时 新手友好度 75/100
Human-Agent-Society/reef#625 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
-
难度 1/5 1 小时以内 新手友好度 80/100
learningequality/kolibri#15351 · 2 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
Name consistency 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
eellak/triplestore#65 · 1 条评论 ·