
python描述符是实现特定协议的对象,它们通过定义__get__、__set__和__delete__方法来控制类属性的访问行为。当一个描述符实例被放置在类的字典中时,对该类实例上相应属性的访问(获取、设置、删除)将被委托给描述符的相应方法。
一个典型的描述符模式是,它在宿主实例上存储实际的数据。为了实现这一点,描述符需要一个名称来在宿主实例的__dict__中查找或设置值。这个名称通常在描述符的__set_name__方法中被初始化。
考虑以下一个尝试实现简单数据存储的描述符:
class MyDescriptor:
def __init__(self, default_value=None):
self.default_value = default_value
self.internal_name = None # 将在__set_name__中设置
def __set_name__(self, owner, name):
# 错误示范:将内部名称设置为与描述符绑定的外部名称相同
self.internal_name = name
def __get__(self, instance, owner):
if instance is None:
return self # 当通过类访问时返回描述符本身
# 错误示范:这里会引发递归
return getattr(instance, self.internal_name)
def __set__(self, instance, value):
if instance is None:
raise AttributeError("Cannot set attribute on class directly.")
# 错误示范:这里也会引发递归
setattr(instance, self.internal_name, value)
class MyClass:
# 描述符被绑定到 'data' 这个名称
data = MyDescriptor(default_value=0)
# 尝试使用 MyClass
# instance = MyClass()
# print(instance.data) # 这会引发 RecursionError当执行print(instance.data)时,Python会尝试获取instance.data的值。由于data是一个描述符,Python会调用MyDescriptor实例的__get__(instance, MyClass)方法。
在__get__方法内部,我们有return getattr(instance, self.internal_name)。此时,self.internal_name的值是'data'(因为它是在__set_name__中被设置为name参数的值)。因此,这个表达式等同于getattr(instance, 'data')。
立即学习“Python免费学习笔记(深入)”;
问题在于,getattr(instance, 'data')会再次触发对instance.data的访问,而instance.data又是一个描述符,于是Python会再次调用MyDescriptor实例的__get__方法。这就形成了一个无限递归循环:__get__调用getattr,getattr又调用__get__,直到达到Python的最大递归深度限制,抛出RecursionError。
__set__方法中的setattr(instance, self.internal_name, value)也会遇到同样的问题,因为它同样会重新触发对描述符的调用。
解决这个问题的关键在于,描述符内部用于存储实际值的属性名,必须与描述符在宿主类上被绑定的外部属性名不同。通常,我们会选择在内部属性名前加上一个下划线(_)作为约定。
修改后的__set_name__方法如下:
class MyDescriptor:
def __init__(self, default_value=None):
self.default_value = default_value
self.internal_name = None
def __set_name__(self, owner, name):
# 修正:将内部名称设置为与描述符绑定的外部名称不同的值
self.internal_name = f'_{name}'
def __get__(self, instance, owner):
if instance is None:
return self
# 修正:现在 getattr(instance, self.internal_name) 将直接访问实例的 __dict__
# 而不会再次触发描述符的 __get__ 方法
if hasattr(instance, self.internal_name):
return getattr(instance, self.internal_name)
return self.default_value # 如果实例上还没有这个属性,返回默认值
def __set__(self, instance, value):
if instance is None:
raise AttributeError("Cannot set attribute on class directly.")
# 修正:setattr(instance, self.internal_name, value) 将直接在实例的 __dict__ 中设置值
setattr(instance, self.internal_name, value)
class MyClass:
data = MyDescriptor(default_value=0)
name = MyDescriptor(default_value="Unnamed")
# 完整示例
if __name__ == "__main__":
print("--- 使用修正后的描述符 ---")
instance1 = MyClass()
print(f"实例1的默认data: {instance1.data}") # 输出: 实例1的默认data: 0
print(f"实例1的默认name: {instance1.name}") # 输出: 实例1的默认name: Unnamed
instance1.data = 100
instance1.name = "Alice"
print(f"实例1设置后的data: {instance1.data}") # 输出: 实例1设置后的data: 100
print(f"实例1设置后的name: {instance1.name}") # 输出: 实例1设置后的name: Alice
instance2 = MyClass()
print(f"实例2的默认data: {instance2.data}") # 输出: 实例2的默认data: 0
print(f"实例2的默认name: {instance2.name}") # 输出: 实例2的默认name: Unnamed
# 验证不同实例的数据独立性
instance2.data = 200
print(f"实例1的data (未变): {instance1.data}") # 输出: 实例1的data (未变): 100
print(f"实例2的data (已变): {instance2.data}") # 输出: 实例2的data (已变): 200
# 尝试直接访问内部属性(不推荐,但可用于理解)
# print(instance1._data) # AttributeError: '_data'
# 解释:_data 是一个常规属性,但它存在于实例的 __dict__ 中,
# 默认情况下,如果描述符没有定义,直接访问 _data 是可以的。
# 但由于描述符控制了 'data' 的访问,我们通常不直接访问 _data。
# 这里的关键是 getattr(instance, '_data') 不会触发描述符。
print(f"直接访问实例内部存储的data: {getattr(instance1, '_data')}") # 输出: 直接访问实例内部存储的data: 100通过将self.internal_name设置为f'_{name}',例如当描述符绑定到data时,内部存储的名称变为_data。现在:
由于_data是一个在宿主实例instance上直接存储的普通属性,而不是一个描述符,因此getattr(instance, '_data')和setattr(instance, '_data', value)将直接在instance的__dict__中查找或设置名为_data的属性,而不会再次触发MyDescriptor的__get__或__set__方法。这样就成功打破了递归循环。
Python描述符是一个强大而灵活的机制,用于定制属性访问。然而,在实现自定义__get__和__set__方法时,必须特别注意避免无限递归。核心原则是:描述符内部用于存储和检索实际值的属性名,必须与描述符在宿主类上绑定的外部属性名不同。通过在__set_name__中生成一个带有下划线前缀的内部名称,我们可以确保getattr和setattr操作直接作用于实例的__dict__,从而有效地防止递归,并使描述符按预期工作。理解并遵循这一模式,是编写健壮Python描述符的关键。
以上就是Python描述符中的递归陷阱:内部属性名管理最佳实践的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号