MyPy infers descriptors are always ClassVars when testing assignability to protocols
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 38/100
Hướng nghiên cứu
Bắt đầu với descriptor độc lập và ví dụ Protocol trong err_report.py, rồi tái hiện các kết quả bằng cách sử dụng mypy 1.17.1 không có flag. Tiếp theo, truy vết hành vi về tính có thể gán của Protocol đối với các thuộc tính descriptor, rồi xác minh rằng trường hợp biến instance dự kiến thành công, trong khi trường hợp ClassVar bị từ chối như mô tả.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Bug Report
When defining a Protocol for objects containing descriptors, mypy appears to assume descriptors are always ClassVars. Annotating the protocol's descriptor attributes with ClassVar silences mypy, but raises errors in other type checkers (e.g. pyright). Given descriptors are allowed to be used as both instance and class variables (and __get__ / __set__ provide obj: object | None semantics to support this), I think this is a mypy bug.
A real-world example of this is defining a protocol for an SQLAlchemy model, e.g. a protocol might define id: orm.Mapped[int] to match models with an id integer attribute.
To Reproduce
Given the complexity of SQLAlchemy, here's an entirely self-contained example:
from typing import ClassVar, Protocol
class MyDescriptor:
def __init__(self):
self.value = "test"
def __get__(self, obj: object | None, objtype: type[object]) -> str:
return self.value
def __set__(self, obj: object | None, value: str) -> None:
self.value = value
class Foo:
bar = MyDescriptor()
class HasBar(Protocol):
bar: MyDescriptor
class HasBarWithClassVar(Protocol):
bar: ClassVar[MyDescriptor]
instance1: HasBar = Foo() # fails in mypy, passes in pyright
model1: type[HasBar] = Foo # fails in mypy, passes in pyright
instance2: HasBarWithClassVar = Foo() # fails in pyright, passes in mypy
model2: type[HasBarWithClassVar] = Foo # fails in pyright, passes in mypy
Expected Behavior
Assigning Foo to HasBar should type check correctly, and assigning to HasBarWithClassVar should fail.
Actual Behavior
Assigning Foo to HasBar errors in mypy, but checks in pyright. Conversely, assigning to HasBarWithClassVar checks in mypy, but fails in pyright. They seem to fundamentally disagree.
$ mypy err_report.py
err_report.py:27: error: Incompatible types in assignment (expression has type "Foo", variable has type "HasBar") [assignment]
err_report.py:27: note: Following member(s) of "Foo" have conflicts:
err_report.py:27: note: bar: expected "MyDescriptor", got "str"
err_report.py:28: error: Incompatible types in assignment (expression has type "type[Foo]", variable has type "type[HasBar]") [assignment]
Found 2 errors in 1 file (checked 1 source file)
$ pyright err_report.py
/path/to/my/err_report.py
/path/to/my/err_report.py:30:33 - error: Type "Foo" is not assignable to declared type "HasBarWithClassVar"
"Foo" is incompatible with protocol "HasBarWithClassVar"
"bar" is defined as a ClassVar in protocol (reportAssignmentType)
/path/to/my/err_report.py:31:36 - error: Type "type[Foo]" is not assignable to declared type "type[HasBarWithClassVar]"
"Foo" is incompatible with protocol "HasBarWithClassVar"
Type "type[Foo]" is not assignable to type "type[HasBarWithClassVar]"
"bar" is defined as a ClassVar in protocol (reportAssignmentType)
2 errors, 0 warnings, 0 informations
If I were to annotate Foo.bar with ClassVar, then pyright accepts assigning Foo to HasBarWithClassVar (which is what I would expect), but now mypy won't:
class Foo:
bar: ClassVar = MyDescriptor()
$ mypy err_report.py
err_report.py:27: error: Incompatible types in assignment (expression has type "Foo", variable has type "HasBar") [assignment]
err_report.py:27: note: Protocol member HasBar.bar expected instance variable, got class variable
err_report.py:28: error: Incompatible types in assignment (expression has type "type[Foo]", variable has type "type[HasBar]") [assignment]
err_report.py:30: error: Incompatible types in assignment (expression has type "Foo", variable has type "HasBarWithClassVar") [assignment]
err_report.py:30: note: Protocol member HasBarWithClassVar.bar expected instance variable, got class variable
err_report.py:31: error: Incompatible types in assignment (expression has type "type[Foo]", variable has type "type[HasBarWithClassVar]") [assignment]
Found 4 errors in 1 file (checked 1 source file)
Your Environment
- Mypy version used: 1.17.1
- Mypy command-line flags: none
- Mypy configuration options from
mypy.ini(and other config files): n/a - Python version used: 3.13.5
- Ngôn ngữ chính
- Python
- Star
- 20.6k
- Fork
- 3.3k
- Merge trung bình
- 1 ngày 18 giờ
- Pull request đã merge (30 ngày)
- 54
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của python/mypy
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
-
documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
bug topic-configuration topic-error-reporting
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
Issue tương tự
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
zostera/django-bootstrap4#894 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
use-agent-os/agent-os#3276 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
NousResearch/hermes-agent#117848 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
zilliztech/memsearch#759 ·