Python类变量唯一性解析：描述符与实例属性详解

本文探讨了Python中类变量的唯一性问题。通过对比`PySide2.QtCore.Signal`和普通自定义类，解释了为何某些类属性在实例间表现出唯一性，而另一些则共享。核心在于Python的描述符协议。教程将指导开发者如何正确地在`__init__`方法中定义实例独有的属性，以避免不必要的共享，并分析了何时应使用描述符以及何时应采用更简洁的实例属性定义方式。

在Python面向对象编程中，理解类属性与实例属性的区别及其行为至关重要。有时，我们可能会观察到在类定义中声明的属性，在不同的实例中表现出不同的唯一性。本教程将深入探讨这一现象，特别是围绕 PySide2.QtCore.Signal 和普通自定义对象在类中作为属性时的行为差异，并提供最佳实践来确保属性的预期唯一性。

观察到的现象：Signal的唯一性与普通对象的共享性

考虑以下Python代码示例：

from PySide2.QtCore import Signal, QObject

class MyClass:
    pass

class PSClass(QObject):
    onRequest = Signal(str)
    onMySignal = MyClass() # 这是一个类属性

    def __init__(self):
        super().__init__()
        self.onRequest.connect(self.printSomething)

    def send(self, message:str):
        self.onRequest.emit(message)

    def printSomething(self, data:str):
        print(data)

sample_01 = PSClass()
sample_02 = PSClass()

sample_01.send(f"Signal ID:{id(sample_01.onRequest)}, MyClass ID:{id(sample_01.onMySignal)}")
sample_02.send(f"Signal ID:{id(sample_02.onRequest)}, MyClass ID:{id(sample_02.onMySignal)}")

运行上述代码，我们将得到如下输出：

Signal ID:56331376, MyClass ID:15825232
Signal ID:56331392, MyClass ID:15825232

从输出中我们可以清楚地看到，sample_01.onRequest 和 sample_02.onRequest 具有不同的内存地址（ID），这意味着它们是两个独立的 Signal 对象。然而，sample_01.onMySignal 和 sample_02.onMySignal 却拥有相同的内存地址，表明它们共享了同一个 MyClass 实例。

这种差异令人困惑：为什么同样是在类定义中声明的属性，Signal 表现为实例独有，而 MyClass 却被所有实例共享？

核心原因：Python的描述符协议

Signal 表现出实例独有行为的关键在于它实现了Python的描述符协议 (Descriptor Protocol)。描述符是实现了特殊方法 __get__、__set__ 或 __delete__ 中至少一个的对象。当一个类属性是描述符时，它的访问行为会被这些特殊方法所控制。

具体来说，当通过一个实例（例如 sample_01.onRequest）访问一个描述符类属性时，Python会调用该描述符的 __get__ 方法。__get__ 方法通常接收 self（描述符自身）、instance（访问该属性的实例，如 sample_01）和 owner（拥有该描述符的类，如 PSClass）作为参数。Signal 类很可能在其 __get__ 方法中根据 instance 参数返回一个与特定实例绑定的新 Signal 对象或一个实例特定的代理对象，从而实现了每个实例的 onRequest 属性都是唯一的。

与此不同，MyClass 并没有实现描述符协议。因此，onMySignal = MyClass() 仅仅是在 PSClass 类被定义时创建了一个 MyClass 的实例，并将其作为 PSClass 的一个类属性。所有 PSClass 的实例都会共享这个唯一的 MyClass 实例，因为它们都通过类访问同一个 onMySignal 引用。

Python中的方法（即函数在类中定义）也是描述符的一个常见例子。当通过实例调用方法时，方法会自动绑定到该实例，使其能够访问 self。

确保实例属性唯一性的最佳实践

对于大多数非描述符的普通对象，如果希望它们在每个实例中都是独有的，而不是被所有实例共享，正确的做法是在实例的初始化方法 __init__ 中进行定义。

将 onMySignal 的定义从类体移动到 __init__ 方法中，可以确保每次创建 PSClass 的新实例时，都会创建一个全新的 MyClass 对象并赋值给该实例的 onMySignal 属性。

以下是修改后的 PSClass 定义：

from PySide2.QtCore import Signal, QObject

class MyClass:
    pass

class PSClass(QObject):
    onRequest = Signal(str)
    # onMySignal 不再是类属性，它应该在每个实例中是独有的

    def __init__(self):
        super().__init__()
        self.onMySignal = MyClass()  # 在初始化每个新实例时创建独有的 MyClass 对象
        self.onRequest.connect(self.printSomething)

    def send(self, message:str):
        self.onRequest.emit(message)

    def printSomething(self, data:str):
        print(data)

sample_01 = PSClass()
sample_02 = PSClass()

sample_01.send(f"Signal ID:{id(sample_01.onRequest)}, MyClass ID:{id(sample_01.onMySignal)}")
sample_02.send(f"Signal ID:{id(sample_02.onRequest)}, MyClass ID:{id(sample_02.onMySignal)}")

运行修改后的代码，输出将变为：

Signal ID:56331376, MyClass ID:15825232
Signal ID:56331392, MyClass ID:15825232  # 注意，这里的 MyClass ID 可能会不同，取决于运行时环境

更正： 实际运行结果会显示 MyClass ID 也是不同的，因为每次 PSClass 实例化时，self.onMySignal = MyClass() 都会创建一个新的 MyClass 对象。

Signal ID:56331376, MyClass ID:15825232
Signal ID:56331392, MyClass ID:15825248  # MyClass ID 现在也不同了

（具体的ID值会因运行环境而异，但关键是它们不再相同）

何时考虑使用描述符？

虽然你可以通过实现描述符协议来让 MyClass 像 Signal 那样行为，但对于仅仅需要实例独有属性的场景，这通常不是一个推荐的做法。

1. 增加不必要的复杂性： 实现描述符需要编写额外的 __get__ 方法，这增加了代码的复杂性和维护成本。
2. 不符合Pythonic风格： Pythonic的原则是“显式优于隐式”。将实例特有的属性在 __init__ 中设置，清晰地表明了该属性是属于实例的，并且在实例创建时初始化。而通过描述符实现，虽然功能上可行，但会使代码的意图变得不那么直观。类属性通常意味着它要么是所有实例共享的，要么是与类本身相关的，要么是像方法那样具有特殊行为的。
3. 无明显收益： 对于简单的实例独有对象，将它们放在 __init__ 中已经足够清晰和高效。描述符更适用于需要对属性访问进行特殊控制（如类型检查、懒加载、代理模式等）的场景。

总结与最佳实践

• 类属性：在类体中直接定义的属性，它们被类的所有实例共享。如果属性的值在所有实例中都相同，或者它是一个描述符（如 Signal 或方法），则适合作为类属性。
• 实例属性：在 __init__ 方法中通过 self. 定义的属性，它们是每个实例独有的。如果你希望每个实例拥有自己独立的对象副本，那么务必在 __init__ 中进行初始化。
• 描述符：当需要对属性的访问（获取、设置、删除）进行自定义控制时，可以考虑实现描述符协议。PySide2.QtCore.Signal 是一个很好的例子，它利用描述符为每个实例提供了独特的信号绑定机制。
• 选择原则：对于简单的、需要实例独有的对象，优先在 __init__ 中定义。只有当你有明确的理由（例如需要复杂的访问逻辑、代理行为或与实例绑定等）时，才考虑实现自定义描述符。

通过遵循这些原则，你可以编写出更清晰、更易于维护且符合Pythonic风格的代码，有效管理类属性和实例属性的唯一性。