python / python/mypy

=| and &= allowed for immutable set ABC

Offen
#14,741 12 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Bug Report

mypy seems to allow |= and &= for collections.abc.Set, which is an immutable set type. Its documentation declares that it doesn't offer the __ior__ and __iand__ methods. Indeed, mypy rejects the use of these methods directly, but it does allow |= and &=.

A consequence of this is that because collections.abc.Set is covariant in its element type, breaking out of its immutability allows breaking the Liskov substitution principle.

I've checked both the collections.abc and the typeshed implementation of the relevant types and as far as I can make out they seem to be defined in line with the documentation, so I assume this is a mypy issue, but I could be wrong about that.

To Reproduce

https://mypy-play.net/?mypy=latest&python=3.11&gist=ca538f567c30d410778f87454f9d3494

import collections.abc
from typing import TYPE_CHECKING

myset: collections.abc.Set[int] = {1}
if TYPE_CHECKING:
    reveal_type(myset)
alias: collections.abc.Set[int] = myset
myset |= {2}
# proof that the set object has been modified despite being declared immutable
assert alias == {1, 2}

# Consequence: break Liskov

class Parent: pass
class Child(Parent): pass

def f(s: collections.abc.Set[Parent]) -> None:
    # s should be immutable and yet we can extend it
    s |= {Parent()}

children: collections.abc.Set[Child] = {Child()}
# mypy allows this because the immutable `Set` is covariant in its element type.
# This is safe because, it being immutable, the method can not add elements to it.
# Except that with this bug it can, adding an `Parent` to a `Set[Child]`
f(children)
if TYPE_CHECKING:
    reveal_type(children)
# This should never happen
assert any(isinstance(child, Parent) for child in children)

Expected Behavior

I expected mypy to reject |= and &= for collections.abc.Set and only allow it for collections.abc.MutableSet.

Actual Behavior

Mypy finds no issues with the snippet:

main.py:6: note: Revealed type is "typing.AbstractSet[builtins.int]"
main.py:27: note: Revealed type is "typing.AbstractSet[__main__.Child]"
Success: no issues found in 1 source file

Your Environment

  • Mypy version used: 0.931 locally, 1.0.0 on mypy-play.net
  • Mypy command-line flags: none
  • Mypy configuration options from mypy.ini (and other config files): none
  • Python version used: 3.9 locally, 3.11 on mypy-play.net

Beitragsleitfaden

Beitragsleitfaden öffnen

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

Beginne mit der verlinkten mypy-play-Reproduktion und verfolge, wie augmentierte Zuweisungen für collections.abc.Set gegenüber MutableSet geprüft werden. Die Arbeit ist abgeschlossen, wenn |= und &= für unveränderliches Set abgelehnt werden, während sie für MutableSet weiterhin erlaubt sind, mit Regressionstests für die gemeldeten Beispiele.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
devtools
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

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