python / python/typing

Conformance suite: Questionable tests in dataclasses_descriptors.py

Offen
#2,259 1 Kommentar 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

topic: conformance tests topic: other
Vorherrschende Sprache
Python
Sterne
1.8k
Forks
302
Ø Merge
23 Std.
Gemergte PRs (30 T.)
8

Beschreibung

The dataclasses_descriptors.py test case has a comment "This portion of the dataclass spec is under-specified in the documentation, but its behavior can be determined from the runtime implementation."
However, some of the behaviors in tests don't align with the runtime behavior.

The first part, which is using a data descriptor Desc1 and a dataclass DC1, is fine.

Then we get this, where Desc2 is a non-data descriptor (only implementing __get__):

@dataclass
class DC2:
    x: Desc2[int]
    y: Desc2[str]
    z: Desc2[str] = Desc2()


assert_type(DC2.x, list[int])
assert_type(DC2.y, list[str])
assert_type(DC2.z, list[str])

However, DC2.x and DC2.y are AttributeErrors at runtime, because there is no Desc2 object in the runtime class dictionary. I don't know if we should require type checkers to produce an error but certainly we should allow it.

Then we construct a DC2 object:


dc2 = DC2(Desc2(), Desc2(), Desc2())
assert_type(dc2.x, int)
assert_type(dc2.y, str)
assert_type(dc2.z, str)

But at runtime, dc2's three attributes are all just those Desc2 objects, not ints or strs, because those objects are stored as instance attributes, so the descriptor protocol never runs on them.

The more complicated case is the z attribute, which has a Desc2 object stored in the class. Dataclasses would conventionally treat this as the default, but it gets the default by conventional access in the class body, which calls the descriptor's __get__ with obj=None. So the runtime default for this field is actually the value you'd get for accessing DC2.z, which is list[str].

Looking at actual type checker behavior, I think pyrefly gets all this pretty much right (which means it fails the test). Mypy and pyright pass the test, but their behavior is wrong.

Since (as the test acknowledges) the behavior is not fully specified, perhaps it is best to delete this test from the conformance suite for now, until we come up with a full specification for the behavior of descriptors in dataclasses.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Lies conformance/tests/dataclasses_descriptors.py und konzentriere dich auf die im Issue beschriebenen Fälle Desc2 und DC2. Überprüfe die assertierten Typen anhand des Laufzeitverhaltens und der unterschiedlichen Ergebnisse von pyrefly, mypy und pyright. Als abgeschlossen gilt dies, wenn die Conformance-Suite kein Verhalten mehr voraussetzt, das vom Laufzeitverhalten nicht spezifiziert oder unterstützt wird, und die vorgeschlagene Entfernung des Tests von den Projektbetreuern geklärt wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
testing-qa
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.