90 % 的 Python 开发者不知道的描述符应用

作者: A遇上方知友 | 来源:发表于2019-05-31 14:39 被阅读0次

    好吧,我承认我标题党了。但是这篇文章的知识点,你有极大的可能并不知道。

    前段时间,我写了一篇描述符的入门级文章,从那些文章里你知道了如何定义描述符,且明白了描述符是如何工作的。

    如果有想要学习Python或者正在学习Python中的小伙伴,需要学习资料的话,可以到我的微信公众号:Python学习知识圈,后台回复:“01”,即可拿Python学习资料

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

    这些装饰器方法,你绝对熟悉得不得了,但是今天并不是要讲他们的用法,而是要讲是如何自己通过 纯Python 实现这些特性。

    先来说说 property 吧。

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

    class Student:
        def __init__(self, name):
            self.name = name
    
        @property
        def math(self):
            return self._math
    
        @math.setter
        def math(self, value):
            if 0 <= value <= 100:
                self._math = value
            else:
                raise ValueError("Valid value must be in [0, 100]")
    复制代码
    

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

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

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

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

    代码如下:

    class TestProperty(object):
    
        def __init__(self, fget=None, fset=None, fdel=None, doc=None):
            self.fget = fget
            self.fset = fset
            self.fdel = fdel
            self.__doc__ = doc
    
        def __get__(self, obj, objtype=None):
            print("in __get__")
            if obj is None:
                return self
            if self.fget is None:
                raise AttributeError
            return self.fget(obj)
    
        def __set__(self, obj, value):
            print("in __set__")
            if self.fset is None:
                raise AttributeError
            self.fset(obj, value)
    
        def __delete__(self, obj):
            print("in __delete__")
            if self.fdel is None:
                raise AttributeError
            self.fdel(obj)
    
        def getter(self, fget):
            print("in getter")
            return type(self)(fget, self.fset, self.fdel, self.__doc__)
    
        def setter(self, fset):
            print("in setter")
            return type(self)(self.fget, fset, self.fdel, self.__doc__)
    
        def deleter(self, fdel):
            print("in deleter")
            return type(self)(self.fget, self.fset, fdel, self.__doc__)
    复制代码
    

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

    class Student:
        def __init__(self, name):
            self.name = name
    
        # 其实只有这里改变
        @TestProperty
        def math(self):
            return self._math
    
        @math.setter
        def math(self, value):
            if 0 <= value <= 100:
                self._math = value
            else:
                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 属性。

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

    # 运行后,会直接打印这一行,这是在实例化 TestProperty 并赋值给第二个math
    in setter
    >>>
    >>> s1.math = 90
    in __set__
    >>> s1.math
    in __get__
    90
    复制代码
    

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

    1.17.4 基于描述符如何实现staticmethod

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

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

    class Test:
        @staticmethod
        def myfunc():
            print("hello")
    
    # 上下两种写法等价
    
    class Test:
        def myfunc():
            print("hello")
        # 重点:这就是描述符的体现
        myfunc = staticmethod(myfunc)
    复制代码
    

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

    @TestProperty
    def math(self):
        return self._math
    
    math = TestProperty(fget=math)
    复制代码
    

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

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

    [图片上传失败...(image-140b40-1559284719108)]

    <figcaption></figcaption>

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

    >>> Test.myfunc()
    in staticmethod __get__
    hello
    >>> Test().myfunc()
    in staticmethod __get__
    hello
    复制代码
    

    1.17.4 基于描述符如何实现classmethod

    同样的 classmethod 也是一样。

    class classmethod(object):
        def __init__(self, f):
            self.f = f
    
        def __get__(self, instance, owner=None):
            print("in classmethod __get__")
    
            def newfunc(*args):
                return self.f(owner, *args)
            return newfunc
    
    class Test:
        def myfunc(cls):
            print("hello")
    
        # 重点:这就是描述符的体现
        myfunc = classmethod(myfunc)
    复制代码
    

    验证结果如下

    >>> Test.myfunc()
    in classmethod __get__
    hello
    >>> Test().myfunc()
    in classmethod __get__
    hello
    复制代码
    

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

    相关文章

      网友评论

        本文标题:90 % 的 Python 开发者不知道的描述符应用

        本文链接:https://www.haomeiwen.com/subject/bnnwtctx.html