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

夏静大大_2605

夏静大大_2605

2026-09-23

178人浏览

原创

__set_name__ 是 Python 3.6 引入的描述符协议方法,用于在类创建后自动接收所属类和属性名,避免手动传参;需满足两个前提:描述符类定义该方法且实例为类变量。

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

__set_name__ 是什么,为什么需要它

在 Python 描述符中,过去要让描述符知道自己被赋给了哪个属性名,只能靠手动传参(比如 MyDescriptor(name="foo")),既啰嗦又容易出错。Python 3.6 引入的 __set_name__ 方法解决了这个问题:解释器会在类创建完成、描述符被赋值给类属性后,自动调用它并传入所属类和属性名

这意味着你不再需要硬编码属性名,也不用依赖 <strong>get</strong> 中临时推断(比如从 frame.f_code.co_names 解析,极不可靠)。

必须满足的两个前提条件

__set_name__ 不会无条件触发,缺一不可:

  • 描述符类必须定义了 __set_name__ 方法(哪怕只写 pass
  • 描述符实例必须是类变量(即直接定义在 class 语句块内),不能是运行时通过 setattr(cls, ...) 动态添加的

常见错误现象:__set_name<strong></strong> 完全没被调用 → 检查是否漏写了方法,或描述符被放到了 init__ 里成了实例属性。

A Python CLI skill for Cutout.Pro visual APIs — background removal, face cutout, and photo enhancement. Supports file upload & image URL input.
A Python CLI skill for Cutout.Pro visual APIs — background removal, face cutout, and photo enhancement. Supports file upload & image URL input.

调用 Cutout.Pro 视觉处理 API 进行背景移除、人像抠图和照片增强,支持文件上传与图片 URL 输入。

下载

典型用法:用属性名初始化描述符内部状态

最常见场景是把属性名存下来,用于后续错误提示、日志或构建键名:

class ValidatedField:
    def __init__(self, type_hint=None):
        self.type_hint = type_hint
<pre class="brush:php;toolbar:false;">def __set_name__(self, owner, name):
    self.name = name  # 自动保存为 'age'、'email' 等
    self.private_name = f"_{name}"

def __get__(self, obj, objtype=None):
    if obj is None:
        return self
    return getattr(obj, self.private_name, None)

def __set__(self, obj, value):
    if not isinstance(value, self.type_hint):
        raise TypeError(f"{self.name} must be {self.type_hint.__name__}")
    setattr(obj, self.private_name, value)

class Person: age = ValidatedField(int) # __set_name__ 自动被调用,name='age' email = ValidatedField(str) # name='email'

注意:owner 参数是类对象(如 Person),可用于检查继承关系或元数据注册;name 才是字符串形式的属性名。

容易忽略的边界情况
  • 如果描述符被多次复用在同一个类里(比如 a = ValidatedField(int); b = ValidatedField(int)),每个实例的 __set_name__ 都会被独立调用,name 各不相同 → 安全。
  • 若描述符被继承,子类中同名属性会触发子类的 __set_name__owner 是子类而非父类 → 符合直觉,但要注意逻辑是否依赖父类名。
  • __set_name<strong></strong> 只在类体执行完后调用,此时类尚未完全构建完成(例如不能安全访问 owner.mro__ 中的某些动态属性),尽量只做轻量初始化。

真正麻烦的是当描述符逻辑依赖属性名,但又想支持别名或动态生成属性时——这时 __set_name__ 已经固定,无法重写,得换思路,比如用工厂函数封装。

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

相关专题

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

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

2023.07.20

1551

4

python能做什么
python能做什么

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

2023.07.25

3684

7

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

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

2023.07.31

1569

3

python教程
python教程

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

2023.08.03

21137

23

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

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

2023.08.04

2607

5

python eval
python eval

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

2023.08.04

2667

5

scratch和python区别
scratch和python区别

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

2023.08.11

1083

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2063

5

热门下载

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

精品课程

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