PyQt 的“pyqtProperty” VS python 的标准“属性”

Question

关于 PyQt5 包的pyqtProperty 类和python 的标准内置property 类，我有几个问题：

1. 为什么在标准属性上使用pyqtProperty？下面给出的代码以两种方式工作。使用 pyqtProperty 而不是 Python 的普通旧 property （用作方法的装饰器）有什么优势？我知道我必须指定pyqtProperty 的返回类型，但我为什么要使用它呢？

2. pyqtProperty 是否继承自 property？属性pyqtProperty.__mro__ 没有显示（结果是PyQt5.QtCore.pyqtProperty, object），我找不到pyqtProperty 的源代码文件。 PyDoc's 命令引用模块PyQt5.QtCore 的.pyd 文件（不是源代码纯文本文件），并且没有存根文件。但是命令help(pyqtProperty) 给我的信息非常相似 与help(property) 获得的信息，不同 在official documentaion 上找到的信息。那么，这些信息从何而来？

3. 为什么用@pyqtProperty 甚至@property 装饰的方法在设置Qobject 时执行？

   回到下面给出的代码：属性方法（在这两种情况下为@pyqtProperty 和@property）在创建属性_custom_property 之前执行，它给出了AttributeError。但这不应该发生，并且对于带有常规 python 类的 @property 装饰器确实不会发生（我也尝试过，下面有一个片段）。当我使用简单的 getter 和 setter 方法（未修饰）时，根本不会发生这种情况（这是正常的）。最奇怪的现象是：这个AttributeError是我在调试模式下运行的时候出现的。在正常模式 (python main.py) 下，属性方法无论如何都会执行，但不会引发错误。

我正在使用 PyQt5 版本 5.9.2 与 Anaconda Distribution，python 3.8 一起安装。

---

这是使用pyuic5生成的Ui_MainWindow.py文件的内容：

from PyQt5 import QtCore, QtGui, QtWidgets

class Ui_MainWindow(object):
    def setupUi(self, MainWindow):
        MainWindow.setObjectName("MainWindow")
        MainWindow.resize(419, 196)
        self.centralwidget = QtWidgets.QWidget(MainWindow)
        self.centralwidget.setObjectName("centralwidget")
        self.horizontalLayout = QtWidgets.QHBoxLayout(self.centralwidget)
        self.horizontalLayout.setObjectName("horizontalLayout")
        self.lineEdit = QtWidgets.QLineEdit(self.centralwidget)
        self.lineEdit.setAlignment(QtCore.Qt.AlignCenter)
        self.lineEdit.setObjectName("lineEdit")
        self.horizontalLayout.addWidget(self.lineEdit)
        self.pushButton = QtWidgets.QPushButton(self.centralwidget)
        self.pushButton.setObjectName("pushButton")
        self.horizontalLayout.addWidget(self.pushButton)
        MainWindow.setCentralWidget(self.centralwidget)
        self.menubar = QtWidgets.QMenuBar(MainWindow)
        self.menubar.setGeometry(QtCore.QRect(0, 0, 419, 21))
        self.menubar.setObjectName("menubar")
        MainWindow.setMenuBar(self.menubar)
        self.statusbar = QtWidgets.QStatusBar(MainWindow)
        self.statusbar.setObjectName("statusbar")
        MainWindow.setStatusBar(self.statusbar)
        self.retranslateUi(MainWindow)
        QtCore.QMetaObject.connectSlotsByName(MainWindow)

    def retranslateUi(self, MainWindow):
        _translate = QtCore.QCoreApplication.translate
        MainWindow.setWindowTitle(_translate("MainWindow", "MainWindow"))
        self.lineEdit.setText(_translate("MainWindow", "test"))
        self.pushButton.setText(_translate("MainWindow", "PushButton"))

---

这是使用property装饰器的main.py文件的内容：

from Ui_MainWindow import Ui_MainWindow
from PyQt5.QtWidgets import QApplication, QMainWindow

class MainWindow(QMainWindow,Ui_MainWindow):
    def __init__(self):
        super().__init__()
        self.setupUi(self)
        self._custom_property = 1
    
    @property
    def custom_property(self):
        print("This method is executed")
        return self._custom_property

if __name__ == "__main__":
    app = QApplication([])
    window = MainWindow()
    window.show()
    app.exec_()

---

这是使用pyqtProperty装饰器的main.py文件的内容：

from Ui_MainWindow import Ui_MainWindow
from PyQt5.QtWidgets import QApplication, QMainWindow
from PyQt5.QtCore import pyqtProperty

class MainWindow(QMainWindow,Ui_MainWindow):
    def __init__(self):
        super().__init__()
        self.setupUi(self)
        self._custom_property = 1
    
    @pyqtProperty(int)
    def custom_property(self):
        print("This method is executed")
        return self._custom_property

if __name__ == "__main__":
    app = QApplication([])
    window = MainWindow()
    window.show()
    app.exec_()

---

我不会放没有装饰器的主文件的内容（只需删除上面代码中的@ 行）。
但这是一个带有property 装饰器的简单文件，表明它没有在__init__ 方法中执行

class Test:
    
    def __init__(self) -> None:
        pass
    
    @property
    def x(self):
        print("This method is not executed in init")
        return self._x
    
    def setx(self,value):
        self._x = value

if __name__ == "__main__":
    a = Test()

Answer 1

1. pyqtProperty 和 property 之间的区别，不是优势，是这些属性可以通过 Qt 拥有的 metaObject 访问，而最后一个工具用于各种Qt 中的任务，例如在 QML 中公开属性、能够在 QtStyleSheet 中使用、在 QPropertyAnimation 中使用等。

2. property 因为pyqtProperty 是一个描述符，所以它不一定要从属性继承（here 是一个如何创建描述符而不从属性继承的示例）。如果你想知道pyqtProperty的实现，那么你应该查看the source code的qpy/QtCore文件夹中的qpycore_pyqtproperty.h和qpycore_pyqtproperty.cpp文件。

3. custom_property 方法调用是由QMetaObject::connectSlotsByName() 引起的，但我认为这是一个错误。如果方法的名称符合特定模式，则此方法会尝试建立语义连接：on_<object name>_<signal name>(<signal parameters>)。我指出这是一个错误，因为如果我使用 PySide2 实现相同的逻辑，我不会观察到这种行为。

Answer 2

eyllanesc 的回答已经足够完整，但我想通过解释一些实际需要使用 pyqtProperty 并且使用标准 python 属性是不够的情况来扩展它：

Qt 样式表

QSS 提供对 Qt 属性的访问：

1. 对于selectors，可以定义一个属性是否匹配指定值的规则；例如，您可以更改所有标记为Ok 或Cancel 的按钮的颜色：

QPushButton[text="Ok"] {
    color: green;
}
QPushButton[text="Cancel"] {
    color: red;
}

请注意，当小部件已经显示（由样式“抛光”）时更改定义外观的属性的值需要重新计算样式表。在上述情况下，如果将按钮的文本从“确定”更改为“取消”，则文本颜色不会发生任何变化。为了实现这一点，需要通过obj.setStyleSheet(obj.styleSheet())重新设置样式表，这可以在小部件本身或具有样式表集（包括 QApplication）。
最简单的方法是在属性的设置器中执行self.setStyleSheet(self.styleSheet())（可能在检查值是否实际更改之后），即使小部件设置了 no 样式表和规则，这也将起作用在其任何祖先上定义。

1. 可以设置属性，只要它们的类型受 QSS 支持：

#Window {
    qproperty-minimumSize: 300px 300px;
    qproperty-geometry: rect(250 250 400 400);
}

请注意，正如documentation 解释的那样，“qproperty 语法只评估一次，即当小部件被样式修饰时”，因此您不能使用伪状态设置属性（如:hover 状态) 因为它们可能会被忽略或提供意外和不可靠的行为。

项目委托编辑器

默认情况下，项目委托使用其user property 设置编辑器的值。

class MyCustomEditor(QtWidgets.QWidget):
    # ...
    QtCore.pyqtProperty(object, user=True)
    def myCoolProperty(self):
        # ...

这意味着如果你有一个自定义编辑器，并且使用一个带有user标志声明的Qt属性，你只需要实现createEditor()就可以返回自定义编辑器（甚至可以在为特定数据类型自定义QItemEditorFactory），setEditorData() 将自动设置其值，而无需担心索引、数据类型或属性名称。

设计器插件

这更像是一个边缘场景，因为很少需要为设计师创建插件，而且它不是是一件容易的事（PyQt 文档稀缺且大多已过时，并且提供了一些特性和功能C++ 未实现）。但是，如果您确实需要它，在使用插件创建的自定义小部件的属性编辑器框中显示自定义属性的唯一方法是使用 Qt 属性。