成为Python砖家(5): 描述器descriptor的简单理解

2024-08-22 05:04

本文主要是介绍成为Python砖家(5): 描述器descriptor的简单理解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

第一次解释 discriptor 描述符

任何定义了 __get__()__set__()__delete__()方法的对象。当一个类的某个属性是discriptor时,它的特殊绑定行为就会在属性查找时被触发。通常情况下, 使用 a.b来获取、设置或删除一个属性时,会在 a 类的字典中查找名称为 b 的对象。 但如果 b 是一个 descriptor,则会调用对应的descriptor方法。 理解描述器的概念是更深层次理解 Python 的关键, 因为这是许多重要特性的基础, 包括函数、方法、特征函数(properties)、类方法、静态方法以及对超类的引用等。

上面这段是官方文档的中文翻译版本中文字,来自 file:///Users/zz/Documents/python-3.12.5-docs-html/glossary.html#term-descriptor 。 实话说还是很不清晰的。

第二次解释 discriptor 描述符

在 Python 中, 描述符(descriptor)是一种具有特殊方法的对象,用于管理其他对象的属性访问。描述符协议包括三个核心方法:
__get__()方法
__set__()方法
__delete__()方法

第三次解释 discriptor 描述符

在 Python 中,当定义了一个类,这个类含有 __get__(), __set__(), __delete__()三个方法中的任意一个或多个时,这个类的实例,称为 descriptor。
descriptor 可以具体分成两类:
● 非数据描述符(non-data descriptor):前面提到的三个魔术方法中,仅定义了 __get()__方法,没定义 __set()____delete__(),此时的类对象称为 non-data descriptor
● 数据描述符(data descriptor): 在实现了 __set__()__delete__()时(即:只实现了它们两个中的一个,或都实现了),此时的类对象称为 data descriptor
而提到的 __get()__, __set()____delete__()则统称为 descriptor method

通过使用 descriptor 来理解 descriptor: __get()__方法

前一节提到 get(), 很容易误导新人,认为函数参数是空的。完整的函数说明是:
object.get(self, instance, owner=None)

object.__get__(self, instance, owner=None)

(file:///Users/zz/Documents/pydoc-zh-cn/python-3.12.5-docs-html/reference/datamodel.html#object.__get__)
文档里的解释:

调用此方法以获取所有者类的属性(类属性访问)或该类的实例的属性(实例属性访问)。 可选的 owner 参数是所有者类而 instance 是被用来访问属性的实例,如果通过 owner 来访问属性则返回 None。

使用最小复现代码来表述:

class B:def __get__(self, instance, owner):print(f'instance: {instance}, owner: {owner}')if instance:return f'Accessed through instance: {instance}'elif owner:return f'Accessed through owner: {owner}'class A:b = B()# 通过类访问属性,调用了 __get__()
print(A.b)# 通过实例访问属性,调用了 __get__()
a = A()
print(a.b)

运行输出如下:

instance: None, owner: <class '__main__.A'>
Accessed through owner: <class '__main__.A'>
instance: <__main__.A object at 0x100f8c910>, owner: <class '__main__.A'>
Accessed through instance: <__main__.A object at 0x100f8c910>

解释:
类A的成员b是 descriptor, 访问 A.b或 a.b时是访问了方法 __get__()
● A.b:会传入owner,也就是 A.b相当于调用 B.__get__(self, None, actual_owner);
● a.b相当于调用 B.__get__(self, actual_instance, actual_owner)
也就是说:
● descriptor 方法__get__()需要返回一个字符串,至于返回什么样子的字符串,用户可以根据函数参数做判断和给出不同结果,参数有 instance和 owner两个
● instance和 owner是自动传入的,owner总是有值, instance则可能为 None (通过类访问属性)或非 None(通过实例访问属性)

通过使用 descriptor 来理解 descriptor: __set()__和 __set_name()__方法

下面给出使用 __set__()的例子:在 __set__()内做定制化的检查,比如只允给 descriptor 赋值为 int 类型。

class IntAttr:def __get__(self, instance, owner):return instance.__dict__.get(self.name, 330)def __set__(self, instance, value):if isinstance(value, int):instance.__dict__[self.name] = valueelse:raise TypeError(f"Only support int type, got {type(value)}")def __set_name__(self, owner, name):self.name = nameclass ZhejiangRen:id_num = IntAttr()p = ZhejiangRen()
print(p.id_num) # 330p.id_num = 339
print(p.id_num) # 339try:p.id_num = "Zhejiang"
except TypeError as e:print(e) # Only support int type, got <class 'str'>

其中 __set_name__(self, owner, name) 方法是描述符协议的一部分,它在 Python 3.6 及更高版本中被引入,用于让描述符在被绑定到某个类的属性时能够获得该属性的名称。这个方法的主要作用是在描述符第一次被附加到类的属性时调用,为描述符提供了一种知道自己被安装在哪个属性上的机制。

在这里插入图片描述
在这里插入图片描述

在这里插入图片描述

总结

远远谈不上熟悉 descriptor, 仅仅是按照官方文档,把不明白的地方,尝试写了代码,来增加了对于 descriptor 的理解。descriptor首先应当是类的属性,而不能是实例的属性:

class A:b = B() # b 是 descriptorclass C:def __init__(self):d = D() # d 不是 descriptor

descriptor 的类(上述代码中B),应当定义了 __set__()__get__()__delete__()中的任意一个。还可以定义 __set_name__()(since python 3.6)。这几个函数统称为descriptor method, 它们有具体的参数,是:
__get__(self, instance, owner)
__set__(self, instance, value)
__set_name__(self, owner, name)
__delete__(self, instance)
当读取了 descriptor 是调用 __get__(), 当写入 descriptor 是调用 __set__() 删除则是调用 __delete__(). 其实颇有一种 C++ 中 RAII 的感觉,是在原本的操作(读取、赋值、删除)外面包装了一层定制化的东西。这样说来,和decorator也有点像。但是decorator是针对函数的,而descriptor是针对类属性的。

这篇关于成为Python砖家(5): 描述器descriptor的简单理解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1095317

相关文章

Python自定义异常的全面指南(入门到实践)

《Python自定义异常的全面指南(入门到实践)》想象你正在开发一个银行系统,用户转账时余额不足,如果直接抛出ValueError,调用方很难区分是金额格式错误还是余额不足,这正是Python自定义异... 目录引言:为什么需要自定义异常一、异常基础:先搞懂python的异常体系1.1 异常是什么?1.2

更改linux系统的默认Python版本方式

《更改linux系统的默认Python版本方式》通过删除原Python软链接并创建指向python3.6的新链接,可切换系统默认Python版本,需注意版本冲突、环境混乱及维护问题,建议使用pyenv... 目录更改系统的默认python版本软链接软链接的特点创建软链接的命令使用场景注意事项总结更改系统的默

Linux升级或者切换python版本实现方式

《Linux升级或者切换python版本实现方式》本文介绍在Ubuntu/Debian系统升级Python至3.11或更高版本的方法,通过查看版本列表并选择新版本进行全局修改,需注意自动与手动模式的选... 目录升级系统python版本 (适用于全局修改)对于Ubuntu/Debian系统安装后,验证Pyt

Python实现开根号的五种方式

《Python实现开根号的五种方式》在日常数据处理、数学计算甚至算法题中,开根号是一个高频操作,但你知道吗?Python中实现开根号的方式远不止一种!本文总结了5种常用方法,感兴趣的小伙伴跟着小编一起... 目录一、为什么需要多种开根号方式?二、5种开根号方式详解方法1:数学库 math.sqrt() ——

深入理解go中interface机制

《深入理解go中interface机制》本文主要介绍了深入理解go中interface机制,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学... 目录前言interface使用类型判断总结前言go的interface是一组method的集合,不

Python lambda函数(匿名函数)、参数类型与递归全解析

《Pythonlambda函数(匿名函数)、参数类型与递归全解析》本文详解Python中lambda匿名函数、灵活参数类型和递归函数三大进阶特性,分别介绍其定义、应用场景及注意事项,助力编写简洁高效... 目录一、lambda 匿名函数:简洁的单行函数1. lambda 的定义与基本用法2. lambda

Python 函数详解:从基础语法到高级使用技巧

《Python函数详解:从基础语法到高级使用技巧》本文基于实例代码,全面讲解Python函数的定义、参数传递、变量作用域及类型标注等知识点,帮助初学者快速掌握函数的使用技巧,感兴趣的朋友跟随小编一起... 目录一、函数的基本概念与作用二、函数的定义与调用1. 无参函数2. 带参函数3. 带返回值的函数4.

Python跨文件实例化、跨文件调用及导入库示例代码

《Python跨文件实例化、跨文件调用及导入库示例代码》在Python开发过程中,经常会遇到需要在一个工程中调用另一个工程的Python文件的情况,:本文主要介绍Python跨文件实例化、跨文件调... 目录1. 核心对比表格(完整汇总)1.1 自定义模块跨文件调用汇总表1.2 第三方库使用汇总表1.3 导

基于Python实现进阶版PDF合并/拆分工具

《基于Python实现进阶版PDF合并/拆分工具》在数字化时代,PDF文件已成为日常工作和学习中不可或缺的一部分,本文将详细介绍一款简单易用的PDF工具,帮助用户轻松完成PDF文件的合并与拆分操作... 目录工具概述环境准备界面说明合并PDF文件拆分PDF文件高级技巧常见问题完整源代码总结在数字化时代,PD

Python实现Word转PDF全攻略(从入门到实战)

《Python实现Word转PDF全攻略(从入门到实战)》在数字化办公场景中,Word文档的跨平台兼容性始终是个难题,而PDF格式凭借所见即所得的特性,已成为文档分发和归档的标准格式,下面小编就来和大... 目录一、为什么需要python处理Word转PDF?二、主流转换方案对比三、五套实战方案详解方案1: