PR: Add missing kwargs to add_action wrapper by beatreichenbach · Pull Request #531 · spyder-ide/qtpy

beatreichenbach · 2026-02-15T10:03:48Z

This adds the kwargs back to the add_action function and should hopefully fix #472.

However, before proceeding, I would like to add tests for all cases. I'm a bit unsure what cases should be supported. Does this cover everything?

# Case 1 (arg__2 is a callable and arg__3 is kwarg 'shortcut')
arg__1: str
arg__2: object
arg__3: QKeySequence = 0

# Case 2 (arg__3 is a callable and arg__4 is kwarg 'shortcut')
arg__1: QIcon
arg__2: str
arg__3: object
arg__4: QKeySequence = 0 

# Case 3
text: str

# Case 4
icon: QIcon
text: str

# Case 5 (shortcut can be arg or kwarg)
text: str
receiver: QObject
member: str
shortcut: QKeySequence = 0

# Case 6 (shortcut can be arg or kwarg)
icon: QIcon
text: str
receiver: QObject
member: str
shortcut: QKeySequence = 0

# Case 7 (PySide6>=6.3, PyQt6>=6.3)
text: str
shortcut: QKeySequence

# Case 8 (PySide6>=6.3, PyQt6>=6.3)
icon: QIcon
text: str
shortcut: QKeySequence

# Case 9 (PySide6>=6.3, PyQt6>=6.3)
text: str
shortcut: QKeySequence
receiver: QObject
member: str
type: ConnectionType = ConnectionType.AutoConnection

# Case 10 (PySide6>=6.3, PyQt6>=6.3)
icon: QIcon
text: str
shortcut: QKeySequence
receiver: QObject
member: str
type: ConnectionType = ConnectionType.AutoConnection

coveralls · 2026-02-15T10:22:13Z

coverage: 90.757% (+0.9%) from 89.834%
when pulling 8920bed on beatreichenbach:add_action-kwargs
into cc853c3 on spyder-ide:master.

dalthviz · 2026-02-17T23:40:05Z

Hi @beatreichenbach thank you for giving that issue a check! The summary of possible signatures that you mention makes sense to me 👍 For completness, checking to the different bindings and got the following signatures when checking help(QMenu.addAction) from an interpreter:

PyQt5:

addAction(...)
    addAction(self, action: Optional[QAction])
    addAction(self, text: Optional[str]) -> Optional[QAction]
    addAction(self, icon: QIcon, text: Optional[str]) -> Optional[QAction]
    addAction(self, text: Optional[str], slot: PYQT_SLOT, shortcut: Union[QKeySequence, QKeySequence.StandardKey, Optional[str], int] = 0) -> Optional[QAction]
    addAction(self, icon: QIcon, text: Optional[str], slot: PYQT_SLOT, shortcut: Union[QKeySequence, QKeySequence.StandardKey, Optional[str], int] = 0) -> Optional[QAction]

PySide2:

addAction(...)
    addAction(self, arg__1: PySide2.QtGui.QIcon, arg__2: str, arg__3: object, arg__4: typing.Optional[PySide2.QtGui.QKeySequence] = None) -> None
    addAction(self, arg__1: PySide2.QtWidgets.QAction) -> None
    addAction(self, arg__1: str, arg__2: object, arg__3: typing.Optional[PySide2.QtGui.QKeySequence] = None) -> None
    addAction(self, icon: PySide2.QtGui.QIcon, text: str) -> PySide2.QtWidgets.QAction
    addAction(self, icon: PySide2.QtGui.QIcon, text: str, receiver: PySide2.QtCore.QObject, member: bytes, shortcut: typing.Optional[PySide2.QtGui.QKeySequence] = None) -> PySide2.QtWidgets.QAction
    addAction(self, text: str) -> PySide2.QtWidgets.QAction
    addAction(self, text: str, receiver: PySide2.QtCore.QObject, member: bytes, shortcut: typing.Optional[PySide2.QtGui.QKeySequence] = None) -> PySide2.QtWidgets.QAction

PyQt6:

addAction(...) method of PyQt6.sip.wrappertype instance
    addAction(self, icon: QIcon, text: Optional[str]) -> Optional[QAction]
    addAction(self, icon: QIcon, text: Optional[str], slot: PYQT_SLOT, type: Qt.ConnectionType = Qt.AutoConnection) -> Optional[QAction]
    addAction(self, icon: QIcon, text: Optional[str], shortcut: Union[QKeySequence, QKeySequence.StandardKey, Optional[str], int]) -> Optional[QAction]
    addAction(self, icon: QIcon, text: Optional[str], shortcut: Union[QKeySequence, QKeySequence.StandardKey, Optional[str], int], slot: PYQT_SLOT, type: Qt.ConnectionType = Qt.AutoConnection) -> Optional[QAction]
    addAction(self, text: Optional[str]) -> Optional[QAction]
    addAction(self, text: Optional[str], shortcut: Union[QKeySequence, QKeySequence.StandardKey, Optional[str], int]) -> Optional[QAction]
    addAction(self, text: Optional[str], slot: PYQT_SLOT, type: Qt.ConnectionType = Qt.AutoConnection) -> Optional[QAction]
    addAction(self, text: Optional[str], shortcut: Union[QKeySequence, QKeySequence.StandardKey, Optional[str], int], slot: PYQT_SLOT, type: Qt.ConnectionType = Qt.AutoConnection) -> Optional[QAction]
    addAction(self, action: Optional[QAction])

PySide6

addAction(...)
    addAction(self, action: PySide6.QtGui.QAction, /) -> None
    addAction(self, text: str, /) -> PySide6.QtGui.QAction
    addAction(self, text: str, receiver: PySide6.QtCore.QObject, member: Union[bytes, bytearray, memoryview], /, type: PySide6.QtCore.Qt.ConnectionType = Instance(Qt.AutoConnection)) -> PySide6.QtGui.QAction
    addAction(self, text: str, receiver: PySide6.QtCore.QObject, member: Union[bytes, bytearray, memoryview], shortcut: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int], /) -> PySide6.QtGui.QAction
    addAction(self, text: str, shortcut: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int], /) -> PySide6.QtGui.QAction
    addAction(self, text: str, shortcut: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int], receiver: PySide6.QtCore.QObject, member: Union[bytes, bytearray, memoryview], /, type: PySide6.QtCore.Qt.ConnectionType = Instance(Qt.AutoConnection)) -> PySide6.QtGui.QAction
    addAction(self, text: str, shortcut: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int], callable: object, /) -> PySide6.QtGui.QAction
    addAction(self, text: str, callable: object, /) -> PySide6.QtGui.QAction
    addAction(self, text: str, arg__2: object, /, shortcut: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int, NoneType] = None) -> None
    addAction(self, icon: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], text: str, /) -> PySide6.QtGui.QAction
    addAction(self, icon: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], text: str, receiver: PySide6.QtCore.QObject, member: Union[bytes, bytearray, memoryview], /, type: PySide6.QtCore.Qt.ConnectionType = Instance(Qt.AutoConnection)) -> PySide6.QtGui.QAction
    addAction(self, icon: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], text: str, receiver: PySide6.QtCore.QObject, member: Union[bytes, bytearray, memoryview], shortcut: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int], /) -> PySide6.QtGui.QAction
    addAction(self, icon: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], text: str, shortcut: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int], /) -> PySide6.QtGui.QAction
    addAction(self, icon: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], text: str, shortcut: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int], receiver: PySide6.QtCore.QObject, member: Union[bytes, bytearray, memoryview], /, type: PySide6.QtCore.Qt.ConnectionType = Instance(Qt.AutoConnection)) -> PySide6.QtGui.QAction
    addAction(self, icon: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], text: str, shortcut: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int], callable: object, /) -> PySide6.QtGui.QAction
    addAction(self, icon: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], text: str, callable: object, /) -> PySide6.QtGui.QAction
    addAction(self, arg__1: Union[PySide6.QtGui.QIcon, PySide6.QtGui.QPixmap], text: str, arg__3: object, /, shortcut: Union[PySide6.QtGui.QKeySequence, PySide6.QtCore.QKeyCombination, PySide6.QtGui.QKeySequence.StandardKey, str, int, NoneType] = None) -> None

So seems like one missing signature from the ones listed in the OP is passing a QAction instance as arg

beatreichenbach · 2026-02-18T04:37:18Z

Okay thanks, I'll add a check for all of them and try to refactor that add_action wrapper.

for more information, see https://pre-commit.ci

beatreichenbach · 2026-02-22T05:44:54Z

tests/test_qtwidgets.py

+        menu.addAction(icon, text, func, shortcut=shortcut)
+        menu.addAction(icon, text, receiver, member, shortcut)
+
+        # Qt 5


These signatures are valid in Qt5 but not Qt6, do we still need to support them?
They won't error with Qt5 but will error with Qt6.

I think they should still be available to ensure things with Qt5 bindings work. If no Qt6 bindings signature is usable with the passed arguments we should detect that case and probably at the very least show a warning explaining the situation (something like no Qt6 compatible signature is available please use one of the following to keep compatibility between Qt versions...).

Hm, we'd have to also change this section here:

qtpy/qtpy/QtWidgets.py

Line 225 in cc853c3

if PYQT5 or PYSIDE2 or _parse_version(_qt_version) < _parse_version("6.4"):

I feel like the error is pretty clear already:
AttributeError: PySide6.QtWidgets.QMenu.addAction(): unsupported keyword 'shortcut'

This way we're also ensuring that we're not adding unnecessary code for when the user uses a modern Qt6 binding.

Are you okay, if we just leave it as is?

beatreichenbach · 2026-02-22T05:46:00Z

qtpy/_utils.py

+    shortcut = kwargs.pop("shortcut", None)
+    connection_type = kwargs.pop("type", None)
+    if connection_type:
+        warnings.warn("type argument is not supported in Qt<6.3")


These signatures got added in 6.3 and won't error in Qt5 but type is not supported. How should this be handled?

Showing a warning if someone uses the argument with a binding that doesn't support it makes sense to me

If we leave the AttributeError, should we then also change this warning to an exception?

AttributeError: QtWidgets.QMenu.addAction(): unsupported keyword 'type'

beatreichenbach · 2026-02-22T05:47:37Z

tests/test_qtwidgets.py

-        "QtPy with an icon and a QKeySequence shortcut",
-        QtGui.QKeySequence.UnknownKey,
+
+    # Actions


These tests have only been added to QMenu, in theory qtpy supports these for QToolBar as well.
But in Qt6 these also are valid for QWidget. But in Qt5 they don't exist at all.
Does QtPy provide backwards compatibility for everything? I'm a bit confused with that.

As a little bit of context the original PR from where this patch approach comes is #437 The idea shown there only takes care of the more simple cases of compatibility for QMenu and QToolbar so I will say we currently only support backwards compatibility for QMenu and QToolbar addAction

I added tests for QToolbar.

beatreichenbach force-pushed the add_action-kwargs branch 2 times, most recently from 508b392 to 8920bed Compare February 15, 2026 10:07

ccordoba12 requested a review from dalthviz February 15, 2026 19:42

dalthviz added this to the v2.5.0 milestone Feb 17, 2026

beatreichenbach added 2 commits February 21, 2026 21:42

fix: Add kwargs to add_action wrapper

ba2e8b8

test: add addAction

5b509df

beatreichenbach force-pushed the add_action-kwargs branch from 8920bed to 5b509df Compare February 22, 2026 05:43

[pre-commit.ci] auto fixes from pre-commit.com hooks

c8f3286

for more information, see https://pre-commit.ci

beatreichenbach commented Feb 22, 2026

View reviewed changes

dalthviz assigned beatreichenbach Mar 3, 2026

dalthviz changed the title ~~fix: Add kwargs to add_action wrapper~~ PR: Add missing kwargs to add_action wrapper Mar 3, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

PR: Add missing kwargs to add_action wrapper#531

PR: Add missing kwargs to add_action wrapper#531
beatreichenbach wants to merge 3 commits intospyder-ide:masterfrom
beatreichenbach:add_action-kwargs

beatreichenbach commented Feb 15, 2026

Uh oh!

coveralls commented Feb 15, 2026

Uh oh!

dalthviz commented Feb 17, 2026

Uh oh!

beatreichenbach commented Feb 18, 2026

Uh oh!

beatreichenbach Feb 22, 2026

Uh oh!

dalthviz Mar 3, 2026 •

edited

Loading

Uh oh!

beatreichenbach Mar 15, 2026

Uh oh!

beatreichenbach Feb 22, 2026

Uh oh!

dalthviz Mar 3, 2026

Uh oh!

beatreichenbach Mar 15, 2026

Uh oh!

beatreichenbach Feb 22, 2026

Uh oh!

dalthviz Mar 3, 2026

Uh oh!

beatreichenbach Mar 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

beatreichenbach commented Feb 15, 2026

Uh oh!

coveralls commented Feb 15, 2026

Uh oh!

dalthviz commented Feb 17, 2026

Uh oh!

beatreichenbach commented Feb 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dalthviz Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dalthviz Mar 3, 2026 •

edited

Loading