主页 > 开发 > 这个 Python 知识点,90% 的人都得挂~

这个 Python 知识点,90% 的人都得挂~

Python编程时光 开发 2020年08月24日

学习 Python 这么久了,说起 Python 的优雅之处,能让我脱口而出的, Descriptor(描述符)特性可以排得上号。

描述符 是Python 语言独有的特性,它不仅在应用层使用,在语言语法糖的实现上也有使用到(在下面的文章会一一介绍)。

当你点进这篇文章时

  • 你也许没学过描述符,甚至没听过描述符。

  • 或者你对描述符只是一知半解

无论你是哪种,本篇都将带你全面的学习描述符,一起来感受 Python 语言的优雅。

1. 为什么要使用描述符?

假想你正在给学校写一个成绩管理系统,并没有太多编码经验的你,可能会这样子写。


  1. class Student: 
  2.     def __init__(self, name, math, chinese, english): 
  3.         self.name = name 
  4.         self.math = math 
  5.         self.chinese = chinese 
  6.         self.english = english 
  7.  
  8.     def __repr__(self): 
  9.         return "<Student: {}, math:{}, chinese: {}, english:{}>".format( 
  10.                 self.name, self.math, self.chinese, self.english 
  11.             ) 

看起来一切都很合理


  1. >>> std1 = Student('小明'768768
  2. >>> std1 
  3. <Student: 小明, math:76, chinese: 87, english:68

但是程序并不像人那么智能,不会自动根据使用场景判断数据的合法性,如果老师在录入成绩的时候,不小心录入了将成绩录成了负数,或者超过100,程序是无法感知的。

聪明的你,马上在代码中加入了判断逻辑。


  1. class Student: 
  2.     def __init__(self, name, math, chinese, english): 
  3.         self.name = name 
  4.         if 0 <= math <= 100
  5.             self.math = math 
  6.         else
  7.             raise ValueError("Valid value must be in [0, 100]"
  8.          
  9.         if 0 <= chinese <= 100
  10.             self.chinese = chinese 
  11.         else
  12.             raise ValueError("Valid value must be in [0, 100]"
  13.        
  14.         if 0 <= chinese <= 100
  15.             self.english = english 
  16.         else
  17.             raise ValueError("Valid value must be in [0, 100]"
  18.          
  19.  
  20.     def __repr__(self): 
  21.         return "<Student: {}, math:{}, chinese: {}, english:{}>".format( 
  22.                 self.name, self.math, self.chinese, self.english 
  23.             ) 

这下程序稍微有点人工智能了,能够自己明辨是非了。

 

 

 

 

程序是智能了,但在 __init__ 里有太多的判断逻辑,很影响代码的可读性。巧的是,你刚好学过 Property 特性,可以很好的应用在这里。于是你将代码修改成如下,代码的可读性瞬间提升了不少


  1. class Student: 
  2.     def __init__(self, name, math, chinese, english): 
  3.         self.name = name 
  4.         self.math = math 
  5.         self.chinese = chinese 
  6.         self.english = english 
  7.  
  8.     @property
  9.     def math(self): 
  10.         return self._math 
  11.  
  12.     @math.setter 
  13.     def math(self, value): 
  14.         if 0 <= value <= 100
  15.             self._math = value 
  16.         else
  17.             raise ValueError("Valid value must be in [0, 100]"
  18.  
  19.     @property
  20.     def chinese(self): 
  21.         return self._chinese 
  22.  
  23.     @chinese.setter 
  24.     def chinese(self, value): 
  25.         if 0 <= value <= 100
  26.             self._chinese = value 
  27.         else
  28.             raise ValueError("Valid value must be in [0, 100]"
  29.  
  30.     @property
  31.     def english(self): 
  32.         return self._english 
  33.  
  34.     @english.setter 
  35.     def english(self, value): 
  36.         if 0 <= value <= 100
  37.             self._english = value 
  38.         else
  39.             raise ValueError("Valid value must be in [0, 100]"
  40.  
  41.     def __repr__(self): 
  42.         return "<Student: {}, math:{}, chinese: {}, english:{}>".format( 
  43.                 self.name, self.math, self.chinese, self.english 
  44.             ) 

程序还是一样的人工智能,非常好。

 

 

 

 

你以为你写的代码,已经非常优秀,无懈可击了。

没想到,人外有天,你的主管看了你的代码后,深深地叹了口气:类里的三个属性,math、chinese、english,都使用了 Property 对属性的合法性进行了有效控制。功能上,没有问题,但就是太啰嗦了,三个变量的合法性逻辑都是一样的,只要大于0,小于100 就可以,代码重复率太高了,这里三个成绩还好,但假设还有地理、生物、历史、化学等十几门的成绩呢,这代码简直没法忍。去了解一下 Python 的描述符吧。

经过主管的指点,你知道了「描述符」这个东西。怀着一颗敬畏之心,你去搜索了下关于 描述符的用法。

其实也很简单,一个实现了 描述符协议 的类就是一个描述符。

什么描述符协议:在类里实现了 __get__() 、 __set__() 、 __delete__() 其中至少一个方法。

  • __get__ :用于访问属性。它返回属性的值,若属性不存在、不合法等都可以抛出对应的异常。
  • __set__ :将在属性分配操作中调用。不会返回任何内容。
  • __delete__ :控制删除操作。不会返回内容。

对描述符有了大概的了解后,你开始重写上面的方法。

如前所述,Score 类是一个描述符,当从 Student 的实例访问 math、chinese、english这三个属性的时候,都会经过 Score 类里的三个特殊的方法。这里的 Score 避免了 使用Property 出现大量的代码无法复用的尴尬。


  1. class Score: 
  2.     def __init__(self, default=0): 
  3.         self._score = default
  4.  
  5.     def __set__(self, instance, value): 
  6.         if not isinstance(value, int): 
  7.             raise TypeError('Score must be integer'
  8.         if not 0 <= value <= 100
  9.             raise ValueError('Valid value must be in [0, 100]'
  10.  
  11.         self._score = value 
  12.  
  13.     def __get__(self, instance, owner): 
  14.         return self._score 
  15.  
  16.     def __delete__(self): 
  17.         del self._score 
  18.          
  19. class Student: 
  20.     math = Score(0
  21.     chinese = Score(0
  22.     english = Score(0
  23.  
  24.     def __init__(self, name, math, chinese, english): 
  25.         self.name = name 
  26.         self.math = math 
  27.         self.chinese = chinese 
  28.         self.english = english 
  29.  
  30.  
  31.     def __repr__(self): 
  32.         return "<Student: {}, math:{}, chinese: {}, english:{}>".format( 
  33.                 self.name, self.math, self.chinese, self.english 
  34.             ) 

实现的效果和前面的一样,可以对数据的合法性进行有效控制(字段类型、数值区间等)

 

 

 

 

以上,我举了下具体的实例,从最原始的编码风格到 Property ,最后引出描述符。由浅入深,一步一步带你感受到描述符的优雅之处。

到这里,你需要记住的只有一点,就是描述符给我们带来的编码上的便利,它在实现 保护属性不受修改 、 属性类型检查 的基本功能,同时有大大提高代码的复用率。

2. 描述符的访问规则

描述符分两种:

  • 数据描述符:实现了 __get__ 和  __set__ 两种方法的描述符
  • 非数据描述符:只实现了 __get__ 一种方法的描述符

你一定会问,他们有什么区别呢?网上的讲解,我看过几个,很多都把一个简单的东西讲得复杂了。

其实就一句话, 数据描述器和非数据描述器的区别在于:它们相对于实例的字典的优先级不同。

如果实例字典中有与描述符同名的属性,如果描述符是数据描述符,优先使用数据描述符,如果是非数据描述符,优先使用字典中的属性。

这边还是以上节的成绩管理的例子来说明,方便你理解。


  1. # 数据描述符 
  2. class DataDes: 
  3.     def __init__(self, default=0): 
  4.         self._score = default
  5.  
  6.     def __set__(self, instance, value): 
  7.         self._score = value 
  8.  
  9.     def __get__(self, instance, owner): 
  10.         print("访问数据描述符里的 __get__"
  11.         return self._score 
  12.  
  13. # 非数据描述符 
  14. class NoDataDes: 
  15.     def __init__(self, default=0): 
  16.         self._score = default
  17.  
  18.     def __get__(self, instance, owner): 
  19.         print("访问非数据描述符里的 __get__"
  20.         return self._score 
  21.  
  22.  
  23. class Student: 
  24.     math = DataDes(0
  25.     chinese = NoDataDes(0
  26.  
  27.     def __init__(self, name, math, chinese): 
  28.         self.name = name 
  29.         self.math = math 
  30.         self.chinese = chinese 
  31.          
  32.     def __getattribute__(self, item): 
  33.         print("调用 __getattribute__"
  34.         return super(Student, self).__getattribute__(item) 
  35.       
  36.     def __repr__(self): 
  37.         return "<Student: {}, math:{}, chinese: {},>".format( 
  38.                 self.name, self.math, self.chinese) 

需要注意的是,math 是数据描述符,而 chinese 是非数据描述符。从下面的验证中,可以看出,当实例属性和数据描述符同名时,会优先访问数据描述符(如下面的math),而当实例属性和非数据描述符同名时,会优先访问实例属性( __getattribute__ )


  1. >>> std = Student('xm'8899
  2. >>>  
  3. >>> std.math 
  4. 调用 __getattribute__ 
  5. 访问数据描述符里的 __get__ 
  6. 88
  7. >>> std.chinese 
  8. 调用 __getattribute__ 
  9. 99

讲完了数据描述符和非数据描述符,我们还需要了解的对象属性的查找规律。

当我们对一个实例属性进行访问时,Python 会按 obj.__dict__ →  type(obj).__dict__ →  type(obj)的父类.__dict__ 顺序进行查找,如果查找到目标属性并发现是一个描述符,Python 会调用描述符协议来改变默认的控制行为。

3. 基于描述符如何实现property

经过上面的讲解,我们已经知道如何定义描述符,且明白了描述符是如何工作的。

正常人所见过的描述符的用法就是上面提到的那些,我想说的是那只是描述符协议最常见的应用之一,或许你还不知道,其实有很多 Python 的特性的底层实现机制都是基于 描述符协议 的,比如我们熟悉的 @property 、 @classmethod 、 @staticmethod 和  super 等。

先来说说 property 吧。

有了前面的基础,我们知道了 property 的基本用法。这里我直接切入主题,从第一篇的例子里精简了一下。


  1. class Student: 
  2.     def __init__(self, name): 
  3.         self.name = name 
  4.  
  5.     @property
  6.     def math(self): 
  7.         return self._math 
  8.  
  9.     @math.setter 
  10.     def math(self, value): 
  11.         if 0 <= value <= 100
  12.             self._math = value 
  13.         else
  14.             raise ValueError("Valid value must be in [0, 100]"

不防再简单回顾一下它的用法,通过property装饰的函数,如例子中的 math 会变成 Student 实例的属性。而对 math 属性赋值会进入 使用 math.setter 装饰函数的逻辑代码块。

为什么说 property 底层是基于描述符协议的呢?通过 PyCharm 点击进入 property 的源码,很可惜,只是一份类似文档一样的伪源码,并没有其具体的实现逻辑。

不过,从这份伪源码的魔法函数结构组成,可以大体知道其实现逻辑。

这里我自己通过模仿其函数结构,结合「描述符协议」来自己实现类 property 特性。

代码如下:


  1. class TestProperty(object): 
  2.  
  3.     def __init__(self, fget=None, fset=None, fdel=None, doc=None): 
  4.         self.fget = fget 
  5.         self.fset = fset 
  6.         self.fdel = fdel 
  7.         self.__doc__ = doc 
  8.  
  9.     def __get__(self, obj, objtype=None): 
  10.         print("in __get__"
  11.         if obj is None: 
  12.             return self 
  13.         if self.fget is None: 
  14.             raise AttributeError 
  15.         return self.fget(obj) 
  16.  
  17.     def __set__(self, obj, value): 
  18.         print("in __set__"
  19.         if self.fset is None: 
  20.             raise AttributeError 
  21.         self.fset(obj, value) 
  22.  
  23.     def __delete__(self, obj): 
  24.         print("in __delete__"
  25.         if self.fdel is None: 
  26.             raise AttributeError 
  27.         self.fdel(obj) 
  28.  
  29.  
  30.     def getter(self, fget): 
  31.         print("in getter"
  32.         return type(self)(fget, self.fset, self.fdel, self.__doc__) 
  33.  
  34.     def setter(self, fset): 
  35.         print("in setter"
  36.         return type(self)(self.fget, fset, self.fdel, self.__doc__) 
  37.  
  38.     def deleter(self, fdel): 
  39.         print("in deleter"
  40.         return type(self)(self.fget, self.fset, fdel, self.__doc__) 

然后 Student 类,我们也相应改成如下


  1. class Student: 
  2.     def __init__(self, name): 
  3.         self.name = name 
  4.  
  5.     # 其实只有这里改变 
  6.     @TestProperty
  7.     def math(self): 
  8.         return self._math 
  9.  
  10.     @math.setter 
  11.     def math(self, value): 
  12.         if 0 <= value <= 100
  13.             self._math = value 
  14.         else
  15.             raise ValueError("Valid value must be in [0, 100]"

为了尽量让你少产生一点疑惑,我这里做两点说明:

  1. 使用 TestProperty 装饰后, math 不再是一个函数,而是 TestProperty 类的一个实例。所以第二个math函数可以使用  math.setter 来装饰,本质是调用 TestProperty.setter 来产生一个新的  TestProperty 实例赋值给第二个 math 。

  2. 第一个 math 和第二个  math 是两个不同  TestProperty 实例。但他们都属于同一个描述符类(TestProperty),当对 math 对于赋值时,就会进入  TestProperty.__set__ ,当对math 进行取值里,就会进入  TestProperty.__get__ 。仔细一看,其实最终访问的还是Student实例的  _math 属性。

说了这么多,还是运行一下,更加直观一点。


  1. # 运行后,会直接打印这一行,这是在实例化 TestProperty 并赋值给第二个math 
  2. in setter 
  3. >>> 
  4. >>> s1.math = 90
  5. in __set__ 
  6. >>> s1.math 
  7. in __get__ 
  8. 90

对于以上理解 property 的运行原理有困难的同学,请务必参照我上面写的两点说明。如有其他疑问,可以加微信与我进行探讨。

4. 基于描述符如何实现staticmethod

说完了 property ,这里再来讲讲   @classmethod 和  @staticmethod 的实现原理。

我这里定义了一个类,用了两种方式来实现静态方法。


  1. class Test: 
  2.     @staticmethod
  3.     def myfunc(): 
  4.         print("hello"
  5.  
  6. # 上下两种写法等价 
  7.  
  8. class Test: 
  9.     def myfunc(): 
  10.         print("hello"
  11.     # 重点:这就是描述符的体现 
  12.     myfunc = staticmethod(myfunc) 

这两种写法是等价的,就好像在 property 一样,其实以下两种写法也是等价的。


  1. @TestProperty
  2. def math(self): 
  3.     return self._math 
  4.    
  5. math = TestProperty(fget=math) 

话题还是转回到 staticmethod 这边来吧。

由上面的注释,可以看出 staticmethod 其实就相当于一个描述符类,而 myfunc 在此刻变成了一个描述符。关于  staticmethod 的实现,你可以参照下面这段我自己写的代码,加以理解。

 

 

 

 

调用这个方法可以知道,每调用一次,它都会经过描述符类的 __get__ 。


  1. >>> Test.myfunc() 
  2. in staticmethod __get__ 
  3. hello 
  4. >>> Test().myfunc() 
  5. in staticmethod __get__ 
  6. hello 

5. 基于描述符如何实现classmethod

同样的 classmethod 也是一样。


  1. class classmethod(object): 
  2.     def __init__(self, f): 
  3.         self.f = f 
  4.  
  5.     def __get__(self, instance, owner=None): 
  6.         print("in classmethod __get__"
  7.          
  8.         def newfunc(*args): 
  9.             return self.f(owner, *args) 
  10.         return newfunc 
  11.  
  12. class Test: 
  13.     def myfunc(cls): 
  14.         print("hello"
  15.          
  16.     # 重点:这就是描述符的体现 
  17.     myfunc = classmethod(myfunc) 

验证结果如下


  1. >>> Test.myfunc() 
  2. in classmethod __get__ 
  3. hello 
  4. >>> Test().myfunc() 
  5. in classmethod __get__ 
  6. hello 

讲完了 property 、 staticmethod 和 classmethod 与 描述符的关系。我想你应该对描述符在 Python 中的应用有了更深的理解。对于 super 的实现原理,就交由你来自己完成。

6. 所有实例共享描述符

通过以上内容的学习,你是不是觉得自己已经对描述符足够了解了呢?

可在这里,我想说以上的描述符代码都有问题。

问题在哪里呢?请看下面这个例子。


  1. class Score: 
  2.     def __init__(self, default=0): 
  3.         self._value = default
  4.  
  5.     def __get__(self, instance, owner): 
  6.         return self._value 
  7.  
  8.     def __set__(self, instance, value): 
  9.         if 0 <= value <= 100
  10.             self._value = value 
  11.         else
  12.             raise ValueError 
  13.  
  14.  
  15. class Student: 
  16.     math = Score(0
  17.     chinese = Score(0
  18.     english = Score(0
  19.  
  20.     def __repr__(self): 
  21.         return "<Student math:{}, chinese:{}, english:{}>".format(self.math, self.chinese, self.english) 

Student 里没有像前面那样写了构造函数,但是关键不在这儿,没写只是因为没必要写。

然后来看一下会出现什么样的问题呢


  1. >>> std1 = Student() 
  2. >>> std1 
  3. <Student math:0, chinese:0, english:0
  4. >>> std1.math = 85
  5. >>> std1 
  6. <Student math:85, chinese:0, english:0
  7. >>> std2 = Student() 
  8. >>> std2 # std2 居然共享了std1 的属性值 
  9. <Student math:85, chinese:0, english:0
  10. >>> std2.math = 100
  11. >>> std1 # std2 也会改变std1 的属性值 
  12. <Student math:100, chinese:0, english:0

从结果上来看,std2 居然共享了 std1 的属性值,只要其中一个实例的变量发生改变,另一个实例的变量也会跟着改变。

探其根因,是由于此时 math,chinese,english 三个全部是类变量,导致 std2 和 std1 在访问 math,chinese,english 这三个变量时,其实都是访问类变量。

问题是不是来了?小明和小强的分数怎么可能是绑定的呢?这很明显与实际业务不符。

使用描述符给我们制造了便利,却无形中给我们带来了麻烦,难道这也是描述符的特性吗?

描述符是个很好用的特性,会出现这个问题,是由于我们之前写的描述符代码都是错误的。

描述符的机制,在我看来,只是抢占了访问顺序,而具体的逻辑却要因地制宜,视情况而定。

如果要把 math,chinese,english  这三个变量变成实例之间相互隔离的属性,应该这么写。


  1. class Score: 
  2.     def __init__(self, subject): 
  3.         self.name = subject 
  4.  
  5.     def __get__(self, instance, owner): 
  6.         return instance.__dict__[self.name] 
  7.  
  8.     def __set__(self, instance, value): 
  9.         if 0 <= value <= 100
  10.             instance.__dict__[self.name] = value 
  11.         else
  12.             raise ValueError 
  13.  
  14.  
  15. class Student: 
  16.     math = Score("math"
  17.     chinese = Score("chinese"
  18.     english = Score("english"
  19.  
  20.     def __init__(self, math, chinese, english): 
  21.         self.math = math 
  22.         self.chinese = chinese 
  23.         self.english = english 
  24.  
  25.     def __repr__(self): 
  26.         return "<Student math:{}, chinese:{}, english:{}>".format(self.math, self.chinese, self.english) 

引导程序逻辑进入描述符之后,不管你是获取属性,还是设置属性,都是直接作用于 instance 的。

 

 

 

 

这段代码,你可以仔细和前面的对比一下。

不难看出:

  • 之前的错误代码,更像是把描述符当做了存储节点。

  • 之后的正确代码,则是把描述符直接当做代理,本身不存储值。

以上便是我对描述符的全部分享,希望能对你有所帮助。

标签: