Narrowing an optional class type to an unrelated Protocol causes a false unreachable error
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 20.6k
- 派生
- 3.3k
- 平均合并
- 1 天 18 小时
- 30 天内合并 PR
- 54
描述
Bug Report
If Y is a runtime-checkable protocol which is not implemented by the class X, then mypy will erroneously consider the print statement in the following to be unreachable:
def f(x: Optional[X]) -> None:
if isinstance(x, Y):
print(x.bar())
This is incorrect, because x may be an object created from a subclass of X which does implement Y.
If x is annotated as X (not Optional[X]), then mypy behaves correctly.
To Reproduce
Save the following source code to a file (called foo.py below).
from typing import Optional, Protocol, runtime_checkable
from typing_extensions import reveal_type
class X:
def foo(self) -> int:
...
@runtime_checkable
class Y(Protocol):
def bar(self) -> int:
...
class Z(X):
def foo(self) -> int:
return 5
def bar(self) -> int:
return 6
def f(x: Optional[X]) -> None:
reveal_type(x)
if isinstance(x, Y):
reveal_type(x)
print(x.bar())
def g(x: X) -> None:
reveal_type(x)
if isinstance(x, Y):
reveal_type(x)
print(x.bar())
f(Z())
g(Z())
Run mypy on it with --warn-unreachable
Expected Behavior
> mypy --warn-unreachable foo.py
foo.py:25: note: Revealed type is "Union[foo.X, None]"
foo.py:27: note: Revealed type is "foo.<subclass of "X" and "Y">1"
foo.py:32: note: Revealed type is "foo.X"
foo.py:34: note: Revealed type is "foo.<subclass of "X" and "Y">1"
Success: no issues found in 1 source file
Actual Behavior
> mypy --warn-unreachable foo.py
foo.py:25: note: Revealed type is "Union[foo.X, None]"
foo.py:27: error: Statement is unreachable
foo.py:32: note: Revealed type is "foo.X"
foo.py:34: note: Revealed type is "foo.<subclass of "X" and "Y">1"
Found 1 error in 1 file (checked 1 source file)
(Running the script demonstrates that there is no actual unreachable code at runtime.)
Your Environment
- Mypy version used:
mypy 0.950 (compiled: yes) - Mypy command-line flags:
--warn-unreachable - Mypy configuration options from
mypy.ini(and other config files): None - Python version used:
Python 3.10.4 - Operating system and version:
Edition Windows 10 Business
Version 21H1
Installed on 2.8.2021
OS build 19043.1706
Experience Windows Feature Experience Pack 120.2212.4170.0
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先将提供的复现代码保存为 foo.py,并运行 mypy --warn-unreachable,对比 f 和 g。然后跟踪 Optional[X] 与 X 的类型收窄和不可达诊断行为。完成的标准是:可选情况收窄为可能的 X/Y 子类,并在没有不可达错误的情况下与预期输出一致。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- devtools
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 描述清楚
- 新手友好度
- 45/100