Is the PySide Slot Decorator Necessary?

Question

I’ve seen some example code for PySide slots that uses the @QtCore.Slot decorator, and some that does not. Testing it myself, it doesn’t seem to make a difference. Is there a reason I should or should not use it? For example, in the following code:

import sys
from PySide import QtCore

# the next line seems to make no difference
@QtCore.Slot()
def a_slot(s):
    print s

class SomeClass(QtCore.QObject):
    happened = QtCore.Signal(str)
    def __init__(self):
        QtCore.QObject.__init__(self)
    def do_signal(self):
        self.happened.emit("Hi.")

sc = SomeClass()
sc.happened.connect(a_slot)
sc.do_signal()

the @QtCore.Slot decorator makes no difference; I can omit it, call @QtCore.Slot(str), or even @QtCore.Slot(int), and it still nicely says, “Hi.”

The same seems to be true for PyQt’s pyqtSlot.

Asked By: JasonFruit

||

Source

Answer 1

This link explains the following about the pyqtSlot decorator:

Although PyQt4 allows any Python callable to be used as a slot when
connecting signals, it is sometimes necessary to explicitly mark a
Python method as being a Qt slot and to provide a C++ signature for
it. PyQt4 provides the pyqtSlot() function decorator to do this.

and

Connecting a signal to a decorated Python method also has the
advantage of reducing the amount of memory used and is slightly
faster.

Since the pyqtSlot decorator can take additional argument such as name, it allows different Python methods to handle the different signatures of a signal.

If you don’t use the slot decorator, the signal connection mechanism has to manually work out all the type conversions to map from the underlying C++ function signatures to the Python functions. When the slot decorators are used, the type mapping can be explicit.

Answered By: Austin Phillips

Answer 2

Austin has a good answer, and the answer I’m about to write is a bit outside the scope of your question, but it’s something that has been confusing me and I imagine others will end up on this page wondering the same thing.

If you want to expose Python methods to JavaScript (using QTWebKit), then the @pyqtSlot decorator is mandatory. Undecorated methods are not exposed to JavaScript.

Answered By: Mark E. Haase