
本文深入探讨了python描述符在使用过程中可能遇到的一个常见陷阱:当描述符管理的实例属性与描述符本身在类中定义的名称相同时,会导致无限递归。文章通过详细的代码示例,解释了描述符协议的工作原理,揭示了递归发生的原因,并提供了使用不同内部属性名来规避此问题的最佳实践,旨在帮助开发者正确理解和应用python描述符。
Python描述符是一种强大的机制,允许开发者自定义类属性的访问、设置和删除行为。通过实现__get__、__set__和__delete__方法,描述符可以像代理一样拦截对特定属性的操作。当一个类属性被赋值为一个实现了这些方法的对象时,该对象就成为了一个描述符。
考虑以下一个简单的记录年龄访问日志的描述符示例:
import logging
logging.basicConfig(level=logging.INFO)
class LoggedAgeAccess:
"""一个记录年龄访问和更新日志的描述符。"""
def __get__(self, obj, objtype=None):
if obj is None:
return self # 当通过类访问时返回描述符本身
value = obj._age # 从实例的内部属性获取值
logging.info('Accessing %r giving %r', 'age', value)
return value
def __set__(self, obj, value):
logging.info('Updating %r to %r', 'age', value)
obj._age = value # 将值存储到实例的内部属性
class Person:
"""使用LoggedAgeAccess描述符管理年龄属性的类。"""
age = LoggedAgeAccess() # 描述符实例,管理'age'属性
def __init__(self, name, age):
self.name = name
self.age = age # 调用LoggedAgeAccess.__set__()
def birthday(self):
self.age += 1 # 调用LoggedAgeAccess.__get__()和__set__()
# 示例用法
mary = Person('Mary M', 30)
print(vars(mary)) # 查看实例的__dict__
# 输出:
# INFO:root:Updating 'age' to 30
# {'name': 'Mary M', '_age': 30}在这个示例中,LoggedAgeAccess是一个描述符,它被赋值给了Person类的age属性。当Person实例的age属性被访问或设置时,实际上会调用LoggedAgeAccess的__get__或__set__方法。注意到在LoggedAgeAccess内部,它使用obj._age来实际存储和检索年龄值。这种做法是关键,它避免了与描述符本身的名称冲突。
现在,假设我们修改LoggedAgeAccess描述符,使其在内部也使用obj.age来存储和检索数据,而不是obj._age。
立即学习“Python免费学习笔记(深入)”;
import logging
logging.basicConfig(level=logging.INFO)
class LoggedAgeAccessConflicting:
"""一个有命名冲突的描述符示例。"""
def __get__(self, obj, objtype=None):
if obj is None:
return self
# 尝试从 obj.age 获取值
# 这将再次触发描述符协议,导致递归调用__get__
value = obj.age
logging.info('Accessing %r giving %r', 'age', value)
return value
def __set__(self, obj, value):
logging.info('Updating %r to %r', 'age', value)
# 尝试将值设置到 obj.age
# 这将再次触发描述符协议,导致递归调用__set__
obj.age = value
class PersonConflicting:
"""使用有命名冲突的描述符管理年龄属性的类。"""
age = LoggedAgeAccessConflicting() # 描述符实例
def __init__(self, name, age):
self.name = name
self.age = age # 尝试调用LoggedAgeAccessConflicting.__set__()
# 尝试运行此代码将导致无限递归
# mary_bad = PersonConflicting('Mary B', 30)
# print(vars(mary_bad))当我们尝试创建PersonConflicting的实例并设置其age属性时,例如self.age = age,会发生什么?
问题的根源在于Python的属性访问机制,即描述符协议。当通过obj.attribute访问或设置属性时,Python会按照特定的顺序查找属性:
在我们的冲突示例中:
解决这个问题的关键是确保描述符在内部存储数据时,不会再次触发自身的描述符协议。最常见且推荐的方法是使用一个不同的、通常带有前缀(如_)的属性名来存储实际数据,这个属性名不会被描述符自身管理。
class LoggedAgeAccessCorrect:
"""正确的描述符实现,使用内部属性名。"""
def __get__(self, obj, objtype=None):
if obj is None:
return self
# 从实例的 __dict__ 中直接获取 _age
# 这不会触发描述符协议
value = obj.__dict__['_age']
logging.info('Accessing %r giving %r', 'age', value)
return value
def __set__(self, obj, value):
logging.info('Updating %r to %r', 'age', value)
# 将值直接存储到实例的 __dict__ 中
# 这不会触发描述符协议
obj.__dict__['_age'] = value
class PersonCorrect:
"""使用正确描述符的类。"""
age = LoggedAgeAccessCorrect()
def __init__(self, name, age):
self.name = name
self.age = age # 调用LoggedAgeAccessCorrect.__set__()
mary_correct = PersonCorrect('Mary C', 30)
print(vars(mary_correct))
# 输出:
# INFO:root:Updating 'age' to 30
# {'name': 'Mary C', '_age': 30}在LoggedAgeAccessCorrect中,我们使用obj.__dict__['_age']来直接访问实例的底层字典。这样,当__set__或__get__方法内部需要存储或检索值时,它会直接操作实例的__dict__,而不会再次触发age描述符的协议,从而避免了递归。
另一种常见的写法是直接使用obj._age = value(如最初的例子所示)。这种方式之所以有效,是因为_age不是描述符age的名称,所以obj._age不会触发LoggedAgeAccessCorrect描述符,而是作为普通的实例属性被存储在obj.__dict__中。
Python描述符是实现高级属性管理和元编程的强大工具。然而,理解其工作原理,特别是属性查找和描述符协议的交互至关重要。当描述符管理的属性名与其在类中声明的名称相同时,会陷入无限递归的陷阱。通过在描述符内部使用不同的、通常带有前缀的属性名来存储实际数据,可以有效规避这一问题,确保描述符的正确和安全使用。掌握这一机制对于编写健壮和高效的Python代码至关重要。
以上就是Python描述符中的属性命名冲突与递归陷阱的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号