如何通过Python的__set_name__钩子在类创建时获取属性名?

老磊姑娘_2115

老磊姑娘_2115

2026-07-26

759人浏览

原创

__set_name__ 是描述符协议方法,在类定义阶段、类对象创建完成前被自动调用,用于获取属性名和所属类;它不触发于实例化或赋值时,且仅当描述符作为类变量直接定义在类体中才生效。

如何通过python的__set_name__钩子在类创建时获取属性名?

__set_name__ 是什么,它在什么时候被调用?

__set_name__ 是一个描述符协议方法,在类体执行完毕、类对象创建完成前被 Python 自动调用。它不是在实例化时触发,而是在类定义阶段——也就是解释器构建类字典、处理类属性时调用的。这意味着你无法靠 __init__ 或实例访问来获取属性名,必须依赖这个钩子。

常见错误是把它和 __set__ 混用:后者只在给实例属性赋值时触发,且此时属性名早已丢失;而 __set_name__ 是唯一能让你在类定义期就捕获属性名的机制。

怎么写一个能用 __set_name__ 的描述符?

必须满足两个条件:一是定义了 __set_name__ 方法,二是该对象被用作类变量(即直接写在 class body 里)。Python 会自动把所属类对象和属性名传给它。

  • __set_name__(self, owner, name)name 参数就是你在类里写的那个变量名,比如 age = MyDescriptor() 中的 "age"
  • owner 是当前正在定义的类(尚未完全构建好,但已是 type 实例),可用于检查继承关系或元信息
  • 不能在函数内动态创建描述符并赋值给类变量——那会绕过描述符协议,__set_name__ 根本不会被调用

示例:

Python数据分析(专业版)
Python数据分析(专业版)

企业级Python数据分析方案,支持机器学习建模、时间序列预测、大数据处理与自动化报表。

下载
class Field:
    def __set_name__(self, owner, name):
        self.name = name  # 保存属性名,供后续 __get__/__set__ 使用
        print(f"绑定到类 {owner.__name__} 的属性 {name}")
<p>class Person:
name = Field()  # 触发 <strong>set_name<strong>(Field(), Person, "name")
age = Field()   # 触发 </strong>set_name</strong>(Field(), Person, "age")</p>

为什么有时候 __set_name__ 没被调用?

最常踩的坑是“看起来像描述符,其实不是”。以下情况会导致 __set_name__ 完全不执行:

  • 把描述符实例赋值给实例属性:p = Person(); p.name = Field() —— 这只是普通赋值,不走描述符协议
  • 用 property 或 @property 包裹描述符:name = property(Field()) —— property 本身是描述符,它会接管访问,你的 Field 根本不会被设为类属性
  • __init__ 或其他方法里动态设置类属性:Person.new_field = Field() —— 此时类已创建完毕,Python 不再补调 __set_name__
  • 描述符没被直接写在类体中,而是通过字典更新:Person.__annotations__['x'] = Field() —— 同样跳过协议

__set_name__ 和 __init__ 配合使用的典型场景

实际项目中,__set_name__ 常用于字段注册、ORM 映射或验证逻辑初始化。关键点在于:属性名必须在类创建时确定,之后才能用于生成数据库列名、序列化 key 或类型检查。

  • 不要在 __set_name__ 里做耗时操作(如连接数据库),它发生在 import 阶段,会影响模块加载速度
  • 如果需要延迟初始化,可以把逻辑收进一个标记位,首次 __get____set__ 时再触发
  • 多个同类型描述符共享同一个类(如多个 StringField),__set_name__ 是区分它们的唯一可靠依据

复杂点在于:类还没完成构建,所以不能安全地访问 owner.__mro__ 中父类的同名描述符,也不能假设 owner 已有某个方法。所有依赖类结构的操作,最好推迟到第一次实例访问时再判断。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1531

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

3584

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1549

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

20397

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2527

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2587

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1063

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

576

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2003

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程