成为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如何去掉字符串中最后一个字符》在Python中,字符串是不可变对象,因此无法直接修改原字符串,但可以通过生成新字符串的方式去掉最后一个字符,本文整理了三种高效方法,希望对大家有所帮助... 目录方法1:切片操作(最推荐)方法2:长度计算索引方法3:拼接剩余字符(不推荐,仅作演示)关键注意事

python版本切换工具pyenv的安装及用法

《python版本切换工具pyenv的安装及用法》Pyenv是管理Python版本的最佳工具之一,特别适合开发者和需要切换多个Python版本的用户,:本文主要介绍python版本切换工具pyen... 目录Pyenv 是什么?安装 Pyenv(MACOS)使用 Homebrew:配置 shell(zsh

Python自动化提取多个Word文档的文本

《Python自动化提取多个Word文档的文本》在日常工作和学习中,我们经常需要处理大量的Word文档,本文将深入探讨如何利用Python批量提取Word文档中的文本内容,帮助你解放生产力,感兴趣的小... 目录为什么需要批量提取Word文档文本批量提取Word文本的核心技术与工具安装 Spire.Doc

Python中Request的安装以及简单的使用方法图文教程

《Python中Request的安装以及简单的使用方法图文教程》python里的request库经常被用于进行网络爬虫,想要学习网络爬虫的同学必须得安装request这个第三方库,:本文主要介绍P... 目录1.Requests 安装cmd 窗口安装为pycharm安装在pycharm设置中为项目安装req

Python容器转换与共有函数举例详解

《Python容器转换与共有函数举例详解》Python容器是Python编程语言中非常基础且重要的概念,它们提供了数据的存储和组织方式,下面:本文主要介绍Python容器转换与共有函数的相关资料,... 目录python容器转换与共有函数详解一、容器类型概览二、容器类型转换1. 基本容器转换2. 高级转换示

使用Python将PDF表格自动提取并写入Word文档表格

《使用Python将PDF表格自动提取并写入Word文档表格》在实际办公与数据处理场景中,PDF文件里的表格往往无法直接复制到Word中,本文将介绍如何使用Python从PDF文件中提取表格数据,并将... 目录引言1. 加载 PDF 文件并准备 Word 文档2. 提取 PDF 表格并创建 Word 表格

使用Python实现局域网远程监控电脑屏幕的方法

《使用Python实现局域网远程监控电脑屏幕的方法》文章介绍了两种使用Python在局域网内实现远程监控电脑屏幕的方法,方法一使用mss和socket,方法二使用PyAutoGUI和Flask,每种方... 目录方法一:使用mss和socket实现屏幕共享服务端(被监控端)客户端(监控端)方法二:使用PyA

Python列表的创建与删除的操作指南

《Python列表的创建与删除的操作指南》列表(list)是Python中最常用、最灵活的内置数据结构之一,它支持动态扩容、混合类型、嵌套结构,几乎无处不在,但你真的会创建和删除列表吗,本文给大家介绍... 目录一、前言二、列表的创建方式1. 字面量语法(最常用)2. 使用list()构造器3. 列表推导式

Python使用Matplotlib和Seaborn绘制常用图表的技巧

《Python使用Matplotlib和Seaborn绘制常用图表的技巧》Python作为数据科学领域的明星语言,拥有强大且丰富的可视化库,其中最著名的莫过于Matplotlib和Seaborn,本篇... 目录1. 引言:数据可视化的力量2. 前置知识与环境准备2.1. 必备知识2.2. 安装所需库2.3

SpringBoot简单整合ElasticSearch实践

《SpringBoot简单整合ElasticSearch实践》Elasticsearch支持结构化和非结构化数据检索,通过索引创建和倒排索引文档,提高搜索效率,它基于Lucene封装,分为索引库、类型... 目录一:ElasticSearch支持对结构化和非结构化的数据进行检索二:ES的核心概念Index: