更改的属性不会触发信号

Changed Properties do not trigger signal

对于 QObject 的子类,我想定义一个 属性。发生变化时,应发出信号。根据文档,像这样的东西: p = Property(int, _get_p, _set_p, notify=p_changed) 应该可以工作,但变化不会发出信号。完整示例在这里:

from PySide2.QtCore import QObject, Property, Slot, Signal


class A(QObject):
    p_changed = Signal()

    def __init__(self):
        super(A, self).__init__()
        self._p = 0

    def _get_p(self):
        print(f"Getting p (val: {self._p})")
        return self._p

    def _set_p(self, v):
        print(f"Setting new p: {v}")
        self._p = v
    p = Property(int, _get_p, _set_p, notify=p_changed)


if __name__ == "__main__":
    import sys
    from PySide2.QtWidgets import QApplication, QWidget

    app = QApplication([])


    class W(QWidget):
        def __init__(self, *args):
            super().__init__(*args)
            self.a = A()
            self.a.p_changed.connect(self.test_slot)

            print(self.a.p)
            self.a.p = 42
            # Expecting "Got notified"!
            print(self.a.p)

            # This would print "Got notified":
            # self.a.p_changed.emit()

        @Slot()
        def test_slot(self):
            print("Got notified")


    w = W()
    w.show()
    sys.exit(app.exec_())

将信号关联到 QProperty 并不意味着它将自动发出,而是您必须显式发出。

def _set_p(self, v):
    if self._p != v:
        print(f"Setting new p: {v}")
        self._p = v
        self.p_changed.emit()

有关详细信息,请阅读 The Property System

除了 eyallesc 已经提供的正确答案之外,我还想指出一些进一步的细节。

为什么没有发出信号?

通知信号参数经常被那些还不熟悉Qt Meta-Object System和属性声明的人弄错。我自己几年前也因为同样的原因感到困惑。

但这是有道理的:Qt 不会为您发出信号,也不应该。当 属性 实际上 已更改 时,应仅 发出通知信号,并且由开发人员检查是否(以及如何) 应该设置该值,然后考虑是否更改:您可能需要进行完整性检查,或者您可以在某些条件下阻止设置值。
假设你有一个 属性 只接受大于或等于零的整数值,并且出于某种原因一个函数试图将该值设置为 -1:你可能需要考虑是否应该忽略或清理新值到 0.

您甚至可以使用公开为不同类型的内部数据类型;想象一个 属性 必须是布尔值的字符串表示形式:它将公开为 "True""False",但是如果当前值(由 getter ) 是 "True" 并且 setter 是使用 "true" 调用的,您仍然认为这是一个有效值? setter 的值不同,但 属性 的最终值不会改变,因此它应该 而不是 发出信号。

那它有什么用呢?

现在,您可能想知道指定通知信号有什么用,因为无论如何您都必须自己发出它。

QObject 的一个重要方面是它们通过元对象系统提供了一个强大的接口。 QObject subclass 的每个实例都有一个 metaObject() function that returns a QMetaObject,它提供了 class 的完整检查,包括其方法和属性的完整列表。

这对于必须与即时创建的小部件进行交互的动态界面,或者对于应该全部连接到通知用户更改的函数的复杂 UIs 非常有用。

元对象系统是 Qt 项目视图根据索引数据显示编辑器的方式,因此可以使用独特的抽象接口直接与模型交互,而无需手动连接到信号和函数。

这也是 Designer 能够为每个选定的小部件显示 属性 编辑器的方式,包括自定义插件:它循环遍历整个属性列表(由 class 继承拆分,这也是由元对象的超级 classes 提供)并为每个 属性 类型提供适当的编辑器。

一个伪现实世界的例子

我创建了一个示例程序来展示这个概念:它构建了一个带有一些随机选择的小部件的基本 UI,为其用户设置一个随机值 属性 并将其通知信号连接到一个验证值是否与初始化相同的通用函数。还添加了“恢复”功能以重置初始状态,并添加了“应用”功能以将当前值设置为新的默认值。

使用这种方法的好处之一是您可以创建高级模块化界面(例如,设置对话框),而无需手动连接所有信号。

from PySide2 import QtCore, QtWidgets
from random import choice, randrange
from string import ascii_letters, digits
chars = ascii_letters + digits + '    '

class TestChanged(QtWidgets.QDialog):
    def __init__(self):
        super().__init__()
        layout = QtWidgets.QFormLayout(self, 
            fieldGrowthPolicy=QtWidgets.QFormLayout.AllNonFixedFieldsGrow)

        classes = (QtWidgets.QPushButton, QtWidgets.QCheckBox, 
            QtWidgets.QLineEdit, QtWidgets.QSpinBox)
        self.defaults = {}
        for i in range(10):
            widget = choice(classes)()
            meta = widget.metaObject()
            prop = meta.userProperty()
            layout.addRow('{}:{}'.format(meta.className(), prop.name()), widget)
            if prop.typeName() == 'int':
                value = randrange(100)
            elif prop.typeName() == 'QString':
                value = ''.join(choice(chars) for i in range(randrange(5, 16)))
            elif prop.typeName() == 'bool':
                widget.setCheckable(True) # for QPushButton
                widget.setText(
                    ''.join(choice(chars) for i in range(randrange(5, 16))))
                value = choice((False, True))
            else:
                continue
            widget.setProperty(prop.name(), value)
            metaSignal = prop.notifySignal()
            if metaSignal.isValid():
                signal = getattr(widget, str(metaSignal.name(), 'utf8'))
                signal.connect(self.valueChanged)
                self.defaults[widget] = value

        buttonBox = QtWidgets.QDialogButtonBox(
            QtWidgets.QDialogButtonBox.RestoreDefaults|
            QtWidgets.QDialogButtonBox.Apply|
            QtWidgets.QDialogButtonBox.Close
            )
        layout.addRow(buttonBox)
        self.applyButton = buttonBox.button(buttonBox.Apply)
        self.applyButton.setEnabled(False)
        self.restoreButton = buttonBox.button(buttonBox.RestoreDefaults)
        self.restoreButton.setEnabled(False)

        self.restoreButton.clicked.connect(self.restore)
        self.applyButton.clicked.connect(self.apply)
        buttonBox.rejected.connect(self.close)

        self.infoLabel = QtWidgets.QLabel('Default values', 
            alignment=QtCore.Qt.AlignCenter)
        layout.addRow(self.infoLabel)

    def apply(self):
        for widget, default in self.defaults.items():
            prop = widget.metaObject().userProperty()
            value = widget.property(prop.name())
            if value != default:
                self.defaults[widget] = value
        self.applyButton.setEnabled(False)
        self.restoreButton.setEnabled(False)
        self.infoLabel.setText('New defaults set')

    def restore(self):
        for widget, default in self.defaults.items():
            prop = widget.metaObject().userProperty()
            if widget.property(prop.name()) != default:
                # prevent emitting the notify signal that triggers valueChanged
                blocker = QtCore.QSignalBlocker(widget)
                widget.setProperty(prop.name(), default)
                # for PyQt:
                # with QtCore.QSignalBlocker(widget):
                #     widget.setProperty(prop.name(), default)
                # alternatively, disconnect from valueChanged, set the value,
                # and then connect it again
        self.applyButton.setEnabled(False)
        self.restoreButton.setEnabled(False)
        self.infoLabel.setText('Default values restored')

    def valueChanged(self, value):
        if self.defaults[self.sender()] != value:
            changed = True
        else:
            changed = False
            for widget, default in self.defaults.items():
                prop = widget.metaObject().userProperty()
                if default != widget.property(prop.name()):
                    changed = True
                    break
        if changed:
            self.infoLabel.setText('Settings changed')
        else:
            self.infoLabel.setText('Default values')
        self.applyButton.setEnabled(changed)
        self.restoreButton.setEnabled(changed)

    def closeEvent(self, event):
        for widget, default in self.defaults.items():
            prop = widget.metaObject().userProperty()
            if default != widget.property(prop.name()):
                res = QtWidgets.QMessageBox.question(
                    self, 'Settings changed', 
                    'Settings has been modified, but not applied!\n'
                    'Ignore changes?', 
                    QtWidgets.QMessageBox.Ignore|QtWidgets.QMessageBox.Cancel
                )
                if res != QtWidgets.QMessageBox.Ignore:
                    event.ignore()
                break

    def reject(self):
        if self.close():
            super().reject()


if __name__ == '__main__':
    import sys
    app = QtWidgets.QApplication(sys.argv)
    w = TestChanged()
    w.show()
    sys.exit(app.exec_())