更改的属性不触发信号

Posted

技术标签:

【中文标题】更改的属性不触发信号【英文标题】:Changed Properties do not trigger signal 【发布时间】:2021-09-17 22:00:36 【问题描述】:

对于 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_())

【问题讨论】:

【参考方案1】:

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

为什么没有发出信号?

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

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

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

那么,它是干什么用的?

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

QObject 的一个重要方面是它们通过元对象系统提供了一个强大的接口。 QObject 子类的每个实例都有一个metaObject() 函数,该函数返回一个QMetaObject,它提供对类的全面检查,包括其方法和属性的完整列表。

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

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

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

一个伪现实世界的例子

我创建了一个示例程序来展示这个概念:它使用一些随机选择的小部件构建一个基本 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_())

【讨论】:

【参考方案2】:

将信号与 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。

【讨论】:

以上是关于更改的属性不触发信号的主要内容,如果未能解决你的问题,请参考以下文章

Swift inout 如何在未更改时不复制回属性,以不触发对象设置器

触发的数据触发器不会更改自定义控件的新添加属性

QT程序socket的readyRead信号不触发

Qt不同类之间如何emit信号进行触发操作?

字段为空时不触发远程属性

wpf 触发器理解