Python `__set_name__`：自定义类属性在定义时的行为

好的，没问题。让我们开始这场关于Python __set_name__ 的“相声”讲座！

Python __set_name__：我的属性，我做主！

大家好！我是今天的讲师，人称“代码界的段子手”。今天咱们不聊风花雪月，就来聊聊Python里一个可能被你忽略，但绝对值得了解的“幕后英雄”：__set_name__。

你有没有想过，当你定义一个类属性时，谁在背后默默地把属性名和类关联起来？难道是Python解释器里的“小精灵”吗？虽然听起来有点玄乎，但实际上，__set_name__ 就是那个负责“牵线搭桥”的关键人物。

什么是 __set_name__？别慌，咱先来个例子热热身

先别急着查字典，咱们从一个简单的例子入手：

class MyDescriptor:
    def __set_name__(self, owner, name):
        print(f"MyDescriptor.__set_name__ called: owner={owner}, name={name}")
        self.public_name = name
        self.private_name = '_' + name

    def __get__(self, instance, owner):
        if instance is None:
            return self
        return getattr(instance, self.private_name)

    def __set__(self, instance, value):
        setattr(instance, self.private_name, value)

class MyClass:
    x = MyDescriptor()
    y = MyDescriptor()

instance = MyClass()
instance.x = 10
print(instance.x)  # 输出 10
print(instance.__dict__) # 观察实例的 __dict__

运行这段代码，你会发现控制台输出了类似这样的信息：

MyDescriptor.__set_name__ called: owner=<class '__main__.MyClass'>, name=x
MyDescriptor.__set_name__ called: owner=<class '__main__.MyClass'>, name=y
10
{'_x': 10}

看到没？在 MyClass 定义完成的时候，MyDescriptor 的 __set_name__ 方法就被自动调用了！它接收了两个参数：

owner：拥有这个描述器的类（也就是 MyClass）。
name：描述器作为类属性的名字（比如 x 和 y）。

__set_name__ 的作用：让你的描述器更“聪明”

从上面的例子可以看出，__set_name__ 的主要作用就是让你在描述器被定义的时候，就能拿到它所依附的类和属性名。这有什么用呢？用处可大了！

自动生成私有属性名： 就像例子里那样，你可以根据属性名自动生成一个“私有”属性名（比如 _x），用来存储实际的值，避免和外部访问冲突。这是一种常见的模式，让你的代码更健壮。
动态配置： 你可以根据类的信息，动态地配置描述器的行为。比如，你可以根据类的名字，选择不同的验证规则。
元编程： __set_name__ 是元编程的一个重要组成部分。它可以让你在类定义时，对类进行更精细的控制。

__set_name__ 的调用时机：早起的鸟儿有虫吃

__set_name__ 的调用时机非常关键。它发生在类定义完成时，但在类被实例化之前。也就是说，当你写下 class MyClass: 并且解释器执行完这个类的所有代码之后，__set_name__ 就会被调用。

__set_name__ 的参数：两个重要的“情报”

再来复习一下 __set_name__ 的参数：

owner：拥有描述器的类。注意，这里是类本身，而不是类的实例。你可以通过 owner.__name__ 获取类的名字，通过 owner.__module__ 获取类所在的模块。
name：描述器作为类属性的名字。这是一个字符串，代表你在类中定义的属性名。

这两个参数就像是“情报”，让你的描述器在第一时间掌握关键信息。

__set_name__ 的返回值：不需要，真的不需要

__set_name__ 方法不需要返回值。它主要负责进行一些初始化操作，不需要向解释器传递任何信息。如果你非要返回点什么，Python也不会报错，但也没什么意义。

__set_name__ 的应用场景：让你的代码更优雅

咱们来聊聊 __set_name__ 的实际应用场景。

验证属性：

class Validated:
    def __set_name__(self, owner, name):
        self.private_name = '_' + name

    def __get__(self, instance, owner):
        if instance is None:
            return self
        return getattr(instance, self.private_name)

    def __set__(self, instance, value):
        self.validate(value)
        setattr(instance, self.private_name, value)

    def validate(self, value):
        raise NotImplementedError()

class Integer(Validated):
    def validate(self, value):
        if not isinstance(value, int):
            raise TypeError('Expected an integer')

class NonEmptyString(Validated):
    def validate(self, value):
        if not isinstance(value, str):
            raise TypeError('Expected a string')
        if not value:
            raise ValueError('String cannot be empty')

class MyClass:
    age = Integer()
    name = NonEmptyString()

instance = MyClass()
instance.age = 30
instance.name = "Alice"

# instance.age = "abc"  # 会抛出 TypeError
# instance.name = ""     # 会抛出 ValueError

print(instance.__dict__) # 输出 {'_age': 30, '_name': 'Alice'}

在这个例子中，Integer 和 NonEmptyString 描述器分别负责验证 age 和 name 属性的类型和值。 __set_name__ 帮助我们自动生成了私有属性名，让代码更简洁。

自动生成数据库字段名：

class Field:
    def __set_name__(self, owner, name):
        self.name = name
        self.column_name = name.lower()  # 自动生成数据库字段名

    def __get__(self, instance, owner):
        if instance is None:
            return self
        return instance.__dict__[self.name]

    def __set__(self, instance, value):
        instance.__dict__[self.name] = value

class MyModel:
    id = Field()
    username = Field()
    email = Field()

# 使用的时候，假设MyModel对应数据库表
# 那么 id 对应数据库字段 id, username对应 username, email对应 email
# 这里的自动生成column_name只是一个简化例子，实际应用中可能更复杂

在这个例子中，__set_name__ 自动将属性名转换为小写，作为数据库字段名。这可以大大简化数据库操作的代码。

元类与描述器结合：

class AutoPopulationDescriptor:
    def __set_name__(self, owner, name):
        self.name = name

    def __get__(self, instance, owner):
        if instance is None:
            return self
        return instance.__dict__.get(self.name)

    def __set__(self, instance, value):
        instance.__dict__[self.name] = value

class AutoPopulationMeta(type):
    def __new__(cls, name, bases, attrs):
        for name, value in attrs.items():
            if isinstance(value, AutoPopulationDescriptor):
                value.__set_name__(cls, name) #手动调用
        return super().__new__(cls, name, bases, attrs)

class MyClass(metaclass=AutoPopulationMeta):
    field1 = AutoPopulationDescriptor()
    field2 = AutoPopulationDescriptor()

instance = MyClass()
instance.field1 = "value1"
print(instance.field1)

在这个例子中，我们使用元类 AutoPopulationMeta 来自动遍历类的属性，并手动调用 __set_name__ 方法。虽然看上去有点多此一举，但它可以让你在元类中对描述器进行更灵活的控制。例如，你可以在元类中根据类的名字，动态地决定是否要将某个属性设置为描述器。

__set_name__ 的注意事项：小心驶得万年船

只在类属性上有效： __set_name__ 只对类属性有效，对实例属性无效。也就是说，只有当你直接在类中定义描述器时，__set_name__ 才会被调用。
不要修改 owner： 虽然你可以访问 owner，但最好不要修改它。修改 owner 可能会导致意想不到的错误。
避免循环引用： 如果你的 __set_name__ 方法中创建了对 owner 的强引用，可能会导致循环引用，影响垃圾回收。可以使用 weakref 来避免循环引用。

__set_name__ 与其他描述器方法：各司其职，珠联璧合

__set_name__ 只是描述器协议的一部分。它通常会和其他描述器方法（__get__、__set__、__delete__）一起使用，来实现更强大的功能。

方法	作用	调用时机
`__set_name__`	在描述器被定义为类属性时，自动调用。用于初始化描述器，获取属性名和类的信息。	类定义完成时
`__get__`	在访问描述器属性时调用。用于返回属性的值，或者返回描述器本身（如果通过类访问）。	访问描述器属性时
`__set__`	在设置描述器属性时调用。用于验证属性的值，并将其存储到实例中。	设置描述器属性时
`__delete__`	在删除描述器属性时调用。用于执行清理操作。	删除描述器属性时

总结：__set_name__，你的代码“调味剂”

__set_name__ 是一个强大的工具，可以让你更好地控制类属性的行为。它可以让你自动生成私有属性名，验证属性的值，甚至动态地配置描述器的行为。虽然它不是必需品，但它可以让你的代码更优雅、更健壮、更易于维护。

希望今天的“相声”讲座能让你对 __set_name__ 有更深入的了解。记住，代码就像生活，需要一点“调味剂”才能更精彩！下次当你定义一个类属性时，不妨考虑一下 __set_name__，也许它能给你带来意想不到的惊喜！

感谢大家的收听！咱们下期再见！

发表回复 取消回复

发表回复取消回复