如何利用Python的__set_name__在描述符中自动获取属性名?

雨丽姑娘_2679

雨丽姑娘_2679

2026-06-24

675人浏览

原创

__set_name__是python 3.6+引入的描述符协议方法,当描述符被赋值给类属性时自动调用,接收所有者类(owner)和属性名(name)作为参数,用于在类创建阶段自动绑定属性名称,避免手动传参。

如何利用python的__set_name__在描述符中自动获取属性名?

__set_name__ 是什么,什么时候会被调用?

__set_name__ 是 Python 3.6+ 引入的描述符协议方法,当描述符被赋值给类属性时自动触发,Python 解释器会传入定义该描述符的类对象和属性名字符串。它不是在实例访问时调用,而是在类创建阶段(即类体执行完毕、类对象生成后)由解释器主动调用。

常见错误现象:定义了 __set_name<strong></strong> 却没生效 —— 很可能是因为描述符没真正作为类属性被赋值(比如写在函数里、动态 setattr、或用了 slots__ 但没预留空间),或者 Python 版本低于 3.6。

使用场景包括:

  • 自动绑定字段名,避免手动传参(如 ORM 字段、验证器)
  • 构建带名称上下文的描述符(如日志记录、调试输出)
  • 配合 <strong>get</strong>/<strong>set</strong> 实现“懒加载 + 名称感知”逻辑

怎么写一个带 __set_name__ 的描述符?

关键点是:必须继承自 object(或任何新式类),且不能覆盖 __set_name__ 时不调用父类(除非你明确不想触发默认行为)。它没有返回值,也不该抛异常(否则类定义会失败)。

class LoggedDescriptor:
    def __set_name__(self, owner, name):
        self.name = name  # 保存属性名,供 __get__/__set__ 使用
        self.private_name = f'_{name}'
<pre class="brush:python;toolbar:false;">def __get__(self, obj, objtype=None):
    if obj is None:
        return self
    return getattr(obj, self.private_name, None)

def __set__(self, obj, value):
    print(f"Setting {self.name} = {value}")
    setattr(obj, self.private_name, value)

注意:

  • owner 是定义该描述符的类(不是实例),可用于检查类型或注册元信息
  • name 是字符串,即你在类中写的属性名,如 age = LoggedDescriptor() 中的 "age"
  • 不要尝试在 __set_name__ 里访问 obj 或实例状态 —— 此时实例还不存在

为什么不能靠 __set__ 或 __init__ 获取属性名?

<strong>init</strong> 在描述符实例化时运行,此时还不知道它会被赋给哪个类、哪个名字;<strong>set</strong> 在实例属性被赋值时才触发,那时连类定义都已完成,更无从得知定义时的名称。

Python Testing
Python Testing

Python 测试速查:运行 pytest、使用 mock/patch、参数化、fixtures、异步、覆盖率测试。

下载

所以常见坑包括:

  • 在 <strong>init</strong> 里硬编码 name 参数:导致每次都要手动传,违背“自动获取”的初衷
  • 试图用 inspect.stack() 反向解析赋值语句:不可靠、慢、且在某些环境(如 PyPy、冻结二进制)下失效
  • 忘记 __set_name__ 只对类属性有效:如果把描述符放在实例上(如 obj.x = MyDesc()),它根本不会被调用

和 __set__ / __get__ 配合时要注意什么?

__set_name__ 设置的字段(如 self.name)必须是实例变量,不能存在类变量里 —— 否则多个描述符实例会互相覆盖。

性能影响极小,仅在类定义期执行一次;但要注意兼容性:Python

示例中 self.private<em>name = f'</em>{name}' 是常见模式,用于隔离存储,但需确保:

  • 对应的 <strong>get</strong> 和 <strong>set</strong> 确实用的是同一个私有名
  • 如果类用了 <strong>slots</strong>,得提前声明该私有名(如 <strong>slots</strong> = ('_age',)),否则 setattr 会失败

描述符的“自动命名”看似简单,但一旦涉及多继承、装饰器包装、或动态类构建,__set_name__ 的调用时机和参数就容易出偏差——最稳妥的方式,永远是用最小可复现例子先验证类定义是否真触发了它。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1611

4

python能做什么
python能做什么

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

2023.07.25

3864

7

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

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

2023.07.31

1609

3

python教程
python教程

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

2023.08.03

22297

23

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

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

2023.08.04

2747

5

python eval
python eval

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

2023.08.04

2787

5

scratch和python区别
scratch和python区别

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

2023.08.11

1123

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2163

5

热门下载

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

精品课程

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