成为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如何将OpenCV摄像头视频流通过浏览器播放

《Python如何将OpenCV摄像头视频流通过浏览器播放》:本文主要介绍Python如何将OpenCV摄像头视频流通过浏览器播放的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完... 目录方法1:使用Flask + MJPEG流实现代码使用方法优点缺点方法2:使用WebSocket传输视

Python的端到端测试框架SeleniumBase使用解读

《Python的端到端测试框架SeleniumBase使用解读》:本文主要介绍Python的端到端测试框架SeleniumBase使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全... 目录SeleniumBase详细介绍及用法指南什么是 SeleniumBase?SeleniumBase

Python中对FFmpeg封装开发库FFmpy详解

《Python中对FFmpeg封装开发库FFmpy详解》:本文主要介绍Python中对FFmpeg封装开发库FFmpy,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录一、FFmpy简介与安装1.1 FFmpy概述1.2 安装方法二、FFmpy核心类与方法2.1 FF

基于Python开发Windows屏幕控制工具

《基于Python开发Windows屏幕控制工具》在数字化办公时代,屏幕管理已成为提升工作效率和保护眼睛健康的重要环节,本文将分享一个基于Python和PySide6开发的Windows屏幕控制工具,... 目录概述功能亮点界面展示实现步骤详解1. 环境准备2. 亮度控制模块3. 息屏功能实现4. 息屏时间

Python如何去除图片干扰代码示例

《Python如何去除图片干扰代码示例》图片降噪是一个广泛应用于图像处理的技术,可以提高图像质量和相关应用的效果,:本文主要介绍Python如何去除图片干扰的相关资料,文中通过代码介绍的非常详细,... 目录一、噪声去除1. 高斯噪声(像素值正态分布扰动)2. 椒盐噪声(随机黑白像素点)3. 复杂噪声(如伪

Python中图片与PDF识别文本(OCR)的全面指南

《Python中图片与PDF识别文本(OCR)的全面指南》在数据爆炸时代,80%的企业数据以非结构化形式存在,其中PDF和图像是最主要的载体,本文将深入探索Python中OCR技术如何将这些数字纸张转... 目录一、OCR技术核心原理二、python图像识别四大工具库1. Pytesseract - 经典O

基于Linux的ffmpeg python的关键帧抽取

《基于Linux的ffmpegpython的关键帧抽取》本文主要介绍了基于Linux的ffmpegpython的关键帧抽取,实现以按帧或时间间隔抽取关键帧,文中通过示例代码介绍的非常详细,对大家的学... 目录1.FFmpeg的环境配置1) 创建一个虚拟环境envjavascript2) ffmpeg-py

python使用库爬取m3u8文件的示例

《python使用库爬取m3u8文件的示例》本文主要介绍了python使用库爬取m3u8文件的示例,可以使用requests、m3u8、ffmpeg等库,实现获取、解析、下载视频片段并合并等步骤,具有... 目录一、准备工作二、获取m3u8文件内容三、解析m3u8文件四、下载视频片段五、合并视频片段六、错误

Python中提取文件名扩展名的多种方法实现

《Python中提取文件名扩展名的多种方法实现》在Python编程中,经常会遇到需要从文件名中提取扩展名的场景,Python提供了多种方法来实现这一功能,不同方法适用于不同的场景和需求,包括os.pa... 目录技术背景实现步骤方法一:使用os.path.splitext方法二:使用pathlib模块方法三

Python打印对象所有属性和值的方法小结

《Python打印对象所有属性和值的方法小结》在Python开发过程中,调试代码时经常需要查看对象的当前状态,也就是对象的所有属性和对应的值,然而,Python并没有像PHP的print_r那样直接提... 目录python中打印对象所有属性和值的方法实现步骤1. 使用vars()和pprint()2. 使