MyPy infers descriptors are always ClassVars when testing assignability to protocols

オープン
#19,702 コメント 5 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
38/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
devtools

調査の方向性

err_report.py にある自己完結型の descriptor と Protocol の例から始め、フラグなしで mypy 1.17.1 を使って結果を再現してください。次に、descriptor 属性に対する Protocol の代入可能性の挙動を追跡し、期待される instance-variable のケースが成功する一方で、ClassVar のケースが説明どおり拒否されることを確認してください。

索引モデルが issue の本文から書いたものです。

説明

bug pending topic-descriptors topic-protocols

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
主要言語
Python
スター
20.6k
フォーク
3.3k
平均マージ
1日 18時間
マージ済み PR(30日)
54

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

python/mypy のほかの issue

python/mypy の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。