Python 描述符(Python Descriptor )：深入理解与实战应用
Python 描述符是一种强大且灵活的特性，它能让开发者对属性的访问、赋值和删除等操作进行精细控制。本教程将深入探讨 Python 描述符的基本概念、工作原理，通过丰富的实例和图文并茂的方式，详细介绍描述符的使用方法，同时对重点知识点进行扩展，帮助你全面掌握描述符并将其应用到实际项目中。
一、描述符基础概念
1. 什么是描述符
描述符是实现了特定协议（__get__、__set__ 或 __delete__ 方法）的对象。它允许开发者自定义属性的访问逻辑，从而实现对属性操作的高级控制。简单来说，描述符就像是属性的 “管家”，负责管理属性的读取、赋值和删除等操作。
2. 描述符协议
__get__(self, instance, owner)：用于获取属性的值。self是描述符对象本身，instance是调用该属性的实例对象，如果是通过类访问属性，instance为None，owner是拥有该属性的类。__set__(self, instance, value)：用于设置属性的值。self是描述符对象，instance是调用该属性的实例对象，value是要设置的值。__delete__(self, instance)：用于删除属性。self是描述符对象，instance是调用该属性的实例对象。
3. 描述符类型
- 数据描述符：同时实现了
__get__和__set__方法的描述符。数据描述符具有更高的优先级，当访问属性时，会优先调用数据描述符的__get__方法。 - 非数据描述符：只实现了
__get__方法的描述符。非数据描述符的优先级低于实例的__dict__，如果实例的__dict__中存在同名属性，会优先访问实例的属性。
二、描述符工作原理
1. 属性查找顺序
当访问一个对象的属性时，Python 会按照以下顺序查找：
- 首先检查对象的类（以及其父类）是否有数据描述符，如果有，则调用数据描述符的
__get__方法。 - 然后检查对象的
__dict__中是否存在该属性，如果存在，则返回该属性的值。 - 最后检查对象的类（以及其父类）是否有非数据描述符，如果有，则调用非数据描述符的
__get__方法。
可以用以下流程图来表示：
编辑
2. 示例代码解释
下面是一个简单的描述符示例：
class Descriptor:
def __get__(self, instance, owner):
print(f"Getting value from descriptor, instance: {instance}, owner: {owner}")
return 42
def __set__(self, instance, value):
print(f"Setting value {value} in descriptor, instance: {instance}")
class MyClass:
attr = Descriptor()
obj = MyClass()
print(obj.attr) # 调用描述符的 __get__ 方法
obj.attr = 10 # 调用描述符的 __set__ 方法
在这个示例中，Descriptor 类是一个描述符，它实现了 __get__ 和 __set__ 方法。当我们访问 obj.attr 时，会调用描述符的 __get__ 方法；当我们给 obj.attr 赋值时，会调用描述符的 __set__ 方法。
三、描述符的实际应用
1. 类型检查
描述符可以用于实现属性的类型检查，确保属性只能被赋值为指定类型的值。
class Typed:
def __init__(self, expected_type):
self.expected_type = expected_type
def __get__(self, instance, owner):
return instance.__dict__.get(self.name)
def __set__(self, instance, value):
if not isinstance(value, self.expected_type):
raise TypeError(f"Expected {self.expected_type}, got {type(value)}")
instance.__dict__[self.name] = value
def __set_name__(self, owner, name):
self.name = name
class Person:
age = Typed(int)
name = Typed(str)
p = Person()
p.age = 25 # 正常赋值
try:
p.age = "twenty-five" # 会抛出 TypeError 异常
except TypeError as e:
print(e)
在这个示例中，Typed 描述符用于确保 Person 类的 age 属性只能是整数类型，name 属性只能是字符串类型。
2. 数据验证
描述符还可以用于数据验证，例如确保属性的值在一定范围内。
class Range:
def __init__(self, min_value, max_value):
self.min_value = min_value
self.max_value = max_value
def __get__(self, instance, owner):
return instance.__dict__.get(self.name)
def __set__(self, instance, value):
if not (self.min_value <= value <= self.max_value):
raise ValueError(f"Value must be between {self.min_value} and {self.max_value}")
instance.__dict__[self.name] = value
def __set_name__(self, owner, name):
self.name = name
class Temperature:
celsius = Range(-273.15, float('inf'))
t = Temperature()
t.celsius = 25 # 正常赋值
try:
t.celsius = -300 # 会抛出 ValueError 异常
except ValueError as e:
print(e)
在这个示例中，Range 描述符用于确保 Temperature 类的 celsius 属性的值在 -273.15 到正无穷大之间。
四、重点知识点扩展
1. 描述符与装饰器结合使用
描述符可以与装饰器结合使用，实现更复杂的功能。例如，下面的代码使用描述符和装饰器实现了一个简单的缓存功能：
class CacheDescriptor:
def __init__(self, func):
self.func = func
self.cache = {}
def __get__(self, instance, owner):
if instance is None:
return self
def wrapper(*args, **kwargs):
key = (args, tuple(sorted(kwargs.items())))
if key not in self.cache:
self.cache[key] = self.func(instance, *args, **kwargs)
return self.cache[key]
return wrapper
class MyClass:
@CacheDescriptor
def expensive_computation(self, x):
print(f"Performing expensive computation for {x}")
return x * x
obj = MyClass()
print(obj.expensive_computation(2)) # 会进行计算
print(obj.expensive_computation(2)) # 会从缓存中获取结果
在这个示例中，CacheDescriptor 描述符用于缓存 expensive_computation 方法的计算结果，避免重复计算。
2. 描述符在元类中的应用
描述符可以在元类中使用，实现对类属性的统一管理。例如，下面的代码使用元类和描述符实现了一个自动类型转换的功能：
class AutoConvertDescriptor:
def __init__(self, expected_type):
self.expected_type = expected_type
def __get__(self, instance, owner):
return instance.__dict__.get(self.name)
def __set__(self, instance, value):
try:
instance.__dict__[self.name] = self.expected_type(value)
except ValueError:
raise TypeError(f"Cannot convert {value} to {self.expected_type}")
def __set_name__(self, owner, name):
self.name = name
class AutoConvertMeta(type):
def __new__(cls, name, bases, attrs):
for attr_name, attr_value in attrs.items():
if isinstance(attr_value, type):
attrs[attr_name] = AutoConvertDescriptor(attr_value)
return super().__new__(cls, name, bases, attrs)
class MyClass(metaclass=AutoConvertMeta):
num = int
text = str
obj = MyClass()
obj.num = "10" # 会自动将字符串转换为整数
print(obj.num)
在这个示例中，AutoConvertMeta 元类会自动将类属性转换为 AutoConvertDescriptor 描述符，从而实现属性值的自动类型转换。
浙公网安备 33010602011771号