成为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使用Pandas对比两列数据取最大值的五种方法

《Python使用Pandas对比两列数据取最大值的五种方法》本文主要介绍使用Pandas对比两列数据取最大值的五种方法,包括使用max方法、apply方法结合lambda函数、函数、clip方法、w... 目录引言一、使用max方法二、使用apply方法结合lambda函数三、使用np.maximum函数

Python调用Orator ORM进行数据库操作

《Python调用OratorORM进行数据库操作》OratorORM是一个功能丰富且灵活的PythonORM库,旨在简化数据库操作,它支持多种数据库并提供了简洁且直观的API,下面我们就... 目录Orator ORM 主要特点安装使用示例总结Orator ORM 是一个功能丰富且灵活的 python O

Python使用国内镜像加速pip安装的方法讲解

《Python使用国内镜像加速pip安装的方法讲解》在Python开发中,pip是一个非常重要的工具,用于安装和管理Python的第三方库,然而,在国内使用pip安装依赖时,往往会因为网络问题而导致速... 目录一、pip 工具简介1. 什么是 pip?2. 什么是 -i 参数?二、国内镜像源的选择三、如何

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本

C++初始化数组的几种常见方法(简单易懂)

《C++初始化数组的几种常见方法(简单易懂)》本文介绍了C++中数组的初始化方法,包括一维数组和二维数组的初始化,以及用new动态初始化数组,在C++11及以上版本中,还提供了使用std::array... 目录1、初始化一维数组1.1、使用列表初始化(推荐方式)1.2、初始化部分列表1.3、使用std::

如何通过Python实现一个消息队列

《如何通过Python实现一个消息队列》这篇文章主要为大家详细介绍了如何通过Python实现一个简单的消息队列,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录如何通过 python 实现消息队列如何把 http 请求放在队列中执行1. 使用 queue.Queue 和 reque

Python如何实现PDF隐私信息检测

《Python如何实现PDF隐私信息检测》随着越来越多的个人信息以电子形式存储和传输,确保这些信息的安全至关重要,本文将介绍如何使用Python检测PDF文件中的隐私信息,需要的可以参考下... 目录项目背景技术栈代码解析功能说明运行结php果在当今,数据隐私保护变得尤为重要。随着越来越多的个人信息以电子形

使用Python快速实现链接转word文档

《使用Python快速实现链接转word文档》这篇文章主要为大家详细介绍了如何使用Python快速实现链接转word文档功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 演示代码展示from newspaper import Articlefrom docx import

Python Jupyter Notebook导包报错问题及解决

《PythonJupyterNotebook导包报错问题及解决》在conda环境中安装包后,JupyterNotebook导入时出现ImportError,可能是由于包版本不对应或版本太高,解决方... 目录问题解决方法重新安装Jupyter NoteBook 更改Kernel总结问题在conda上安装了

Python如何计算两个不同类型列表的相似度

《Python如何计算两个不同类型列表的相似度》在编程中,经常需要比较两个列表的相似度,尤其是当这两个列表包含不同类型的元素时,下面小编就来讲讲如何使用Python计算两个不同类型列表的相似度吧... 目录摘要引言数字类型相似度欧几里得距离曼哈顿距离字符串类型相似度Levenshtein距离Jaccard相