python / python/mypy

False positive [override] check, superclass signature wrong

Offen
#16,437 4 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 is using an incorrect method signature on [override] checks. The code looks like this:

from PyQt6 import QtCore, QtGui, QtWidgets

class SEToolsTreeWidget(QtWidgets.QTreeWidget):

    def contextMenuEvent(self, event: QtGui.QContextMenuEvent) -> None:
        ...

Full code: https://github.com/pebenito/setools/blob/pyqt-rework/setoolsgui/widgets/views/treewidget.py

When inspecting the PyQt6 definitions, the contextMenuEvent() parameter is not optional:

$ grep 'def contextMenuEvent' /usr/lib64/python3.11/site-packages/PyQt6/*.pyi
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, a0: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, a0: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, e: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, a0: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, e: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, event: 'QGraphicsSceneContextMenuEvent') -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, event: 'QGraphicsSceneContextMenuEvent') -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, event: 'QGraphicsSceneContextMenuEvent') -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, event: 'QGraphicsSceneContextMenuEvent') -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, event: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, ev: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, a0: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, event: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, contextMenuEvent: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, e: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, a0: QtGui.QContextMenuEvent) -> None: ...
/usr/lib64/python3.11/site-packages/PyQt6/QtWidgets.pyi:    def contextMenuEvent(self, e: QtGui.QContextMenuEvent) -> None: ...

Expected Behavior

No errors

Actual Behavior

setoolsgui/widgets/views/treewidget.py:15: error: Argument 1 of "contextMenuEvent" is incompatible with supertype "QAbstractScrollArea"; supertype defines the argument type as "QContextMenuEvent | None"  [override]
        def contextMenuEvent(self, event: QtGui.QContextMenuEvent) -> None:
                                   ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
setoolsgui/widgets/views/treewidget.py:15: note: This violates the Liskov substitution principle
setoolsgui/widgets/views/treewidget.py:15: note: See https://mypy.readthedocs.io/en/stable/common_issues.html#incompatible-overrides
setoolsgui/widgets/views/treewidget.py:15: error: Argument 1 of "contextMenuEvent" is incompatible with supertype "QWidget"; supertype defines the argument type as "QContextMenuEvent | None"  [override]
        def contextMenuEvent(self, event: QtGui.QContextMenuEvent) -> None:
                                   ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Example run: https://github.com/pebenito/setools/actions/runs/6804093923/job/18500854778#step:8:36

Your Environment

This is running in tox. I hit this both on my Fedora 38 system and also GitHub actions (Ubuntu). tox.ini if useful: https://github.com/pebenito/setools/blob/pyqt-rework/tox.ini

  • Mypy version used: 1.6.0, 1.6.1, 1.7.0
  • Mypy command-line flags: only -p to specify package
  • Mypy configuration options from mypy.ini (and other config files): from pyproject.toml
[tool.mypy]
no_implicit_optional = true
pretty = true

[[tool.mypy.overrides]]
module = ['networkx.*',
          'pytestqt.*']
ignore_missing_imports = true

[[tool.mypy.overrides]]
module = ['tests-gui.*']
disable_error_code = ["union-attr"]
  • Python version used: 3.10-3.12

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

Reproduziere den Bericht mit setoolsgui/widgets/views/treewidget.py unter Verwendung der tox.ini-Umgebung und der mypy-Einstellungen in pyproject.toml. Beginne damit, die Überschreibungsprüfung für die PyQt6-Signatur von contextMenuEvent nachzuverfolgen; als abgeschlossen gilt die Aufgabe, wenn die gezeigte gültige Überschreibung keine False-Positive-Fehler erzeugt, während inkompatible Überschreibungen weiterhin diagnostiziert werden.

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
35/100

Neue Issues direkt in Ihr Postfach

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