美文网首页大数据 爬虫Python AI SqlPython小哥哥
90 % 的 Python 开发者不知道的描述符应用!

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

作者: 14e61d025165 | 来源:发表于2019-05-24 15:04 被阅读2次

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

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

    Python学习交流群:1004391443,这里有资源共享,技术解答,还有小编从最基础的Python资料到项目实战的学习资料都有整理,希望能帮助你更了解python,学习python

    如果你还未学习,可以点击这里进行阅读: Python为什么要使用描述符

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

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

    先来说说 property 吧。

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

    <pre spellcheck="false" style="box-sizing: border-box; margin: 5px 0px; padding: 5px 10px; border: 0px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-variant-numeric: inherit; font-variant-east-asian: inherit; font-weight: 400; font-stretch: inherit; font-size: 16px; line-height: inherit; font-family: inherit; vertical-align: baseline; cursor: text; counter-reset: list-1 0 list-2 0 list-3 0 list-4 0 list-5 0 list-6 0 list-7 0 list-8 0 list-9 0; background-color: rgb(240, 240, 240); border-radius: 3px; white-space: pre-wrap; color: rgb(34, 34, 34); letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">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]")
    复制代码
    </pre>

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

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

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

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

    代码如下:

    <pre spellcheck="false" style="box-sizing: border-box; margin: 5px 0px; padding: 5px 10px; border: 0px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-variant-numeric: inherit; font-variant-east-asian: inherit; font-weight: 400; font-stretch: inherit; font-size: 16px; line-height: inherit; font-family: inherit; vertical-align: baseline; cursor: text; counter-reset: list-1 0 list-2 0 list-3 0 list-4 0 list-5 0 list-6 0 list-7 0 list-8 0 list-9 0; background-color: rgb(240, 240, 240); border-radius: 3px; white-space: pre-wrap; color: rgb(34, 34, 34); letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">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)
    复制代码
    </pre>

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

    <pre spellcheck="false" style="box-sizing: border-box; margin: 5px 0px; padding: 5px 10px; border: 0px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-variant-numeric: inherit; font-variant-east-asian: inherit; font-weight: 400; font-stretch: inherit; font-size: 16px; line-height: inherit; font-family: inherit; vertical-align: baseline; cursor: text; counter-reset: list-1 0 list-2 0 list-3 0 list-4 0 list-5 0 list-6 0 list-7 0 list-8 0 list-9 0; background-color: rgb(240, 240, 240); border-radius: 3px; white-space: pre-wrap; color: rgb(34, 34, 34); letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">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]")
    复制代码
    </pre>

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

    1. 使用 TestProperty 装饰后, math 不再是一个函数,而是 TestProperty 类的一个实例。所以第二个math函数可以使用 math.setter 来装饰,本质是调用 TestProperty.setter 来产生一个新的 TestProperty 实例赋值给第二个 math 。
    2. 第一个 math 和第二个 math 是两个不同 TestProperty 实例。但他们都属于同一个描述符类(TestProperty),当对 math 对于赋值时,就会进入 TestProperty.set ,当对math 进行取值里,就会进入 TestProperty.get 。仔细一看,其实最终访问的还是Student实例的 _math 属性。

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

    <pre spellcheck="false" style="box-sizing: border-box; margin: 5px 0px; padding: 5px 10px; border: 0px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-variant-numeric: inherit; font-variant-east-asian: inherit; font-weight: 400; font-stretch: inherit; font-size: 16px; line-height: inherit; font-family: inherit; vertical-align: baseline; cursor: text; counter-reset: list-1 0 list-2 0 list-3 0 list-4 0 list-5 0 list-6 0 list-7 0 list-8 0 list-9 0; background-color: rgb(240, 240, 240); border-radius: 3px; white-space: pre-wrap; color: rgb(34, 34, 34); letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"># 运行后,会直接打印这一行,这是在实例化 TestProperty 并赋值给第二个math
    in setter

    s1.math = 90
    in set
    s1.math
    in get
    90
    复制代码
    </pre>

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

    1.17.4 基于描述符如何实现staticmethod

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

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

    <pre spellcheck="false" style="box-sizing: border-box; margin: 5px 0px; padding: 5px 10px; border: 0px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-variant-numeric: inherit; font-variant-east-asian: inherit; font-weight: 400; font-stretch: inherit; font-size: 16px; line-height: inherit; font-family: inherit; vertical-align: baseline; cursor: text; counter-reset: list-1 0 list-2 0 list-3 0 list-4 0 list-5 0 list-6 0 list-7 0 list-8 0 list-9 0; background-color: rgb(240, 240, 240); border-radius: 3px; white-space: pre-wrap; color: rgb(34, 34, 34); letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">class Test:
    @staticmethod
    def myfunc():
    print("hello")

    上下两种写法等价

    class Test:
    def myfunc():
    print("hello")
    # 重点:这就是描述符的体现
    myfunc = staticmethod(myfunc)
    复制代码
    </pre>

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

    <pre spellcheck="false" style="box-sizing: border-box; margin: 5px 0px; padding: 5px 10px; border: 0px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-variant-numeric: inherit; font-variant-east-asian: inherit; font-weight: 400; font-stretch: inherit; font-size: 16px; line-height: inherit; font-family: inherit; vertical-align: baseline; cursor: text; counter-reset: list-1 0 list-2 0 list-3 0 list-4 0 list-5 0 list-6 0 list-7 0 list-8 0 list-9 0; background-color: rgb(240, 240, 240); border-radius: 3px; white-space: pre-wrap; color: rgb(34, 34, 34); letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">@TestProperty
    def math(self):
    return self._math

    math = TestProperty(fget=math)
    复制代码
    </pre>

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

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

    <tt-image data-tteditor-tag="tteditorTag" contenteditable="false" class="syl1558681413034" data-render-status="finished" data-syl-blot="image" style="box-sizing: border-box; cursor: text; color: rgb(34, 34, 34); font-family: "PingFang SC", "Hiragino Sans GB", "Microsoft YaHei", "WenQuanYi Micro Hei", "Helvetica Neue", Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; white-space: pre-wrap; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-style: initial; text-decoration-color: initial; display: block;"> image

    <input class="pgc-img-caption-ipt" placeholder="图片描述(最多50字)" value="" style="box-sizing: border-box; outline: 0px; color: rgb(102, 102, 102); position: absolute; left: 187.5px; transform: translateX(-50%); padding: 6px 7px; max-width: 100%; width: 375px; text-align: center; cursor: text; font-size: 12px; line-height: 1.5; background-color: rgb(255, 255, 255); background-image: none; border: 0px solid rgb(217, 217, 217); border-radius: 4px; transition: all 0.2s cubic-bezier(0.645, 0.045, 0.355, 1) 0s;"></tt-image>

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

    <pre spellcheck="false" style="box-sizing: border-box; margin: 5px 0px; padding: 5px 10px; border: 0px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-variant-numeric: inherit; font-variant-east-asian: inherit; font-weight: 400; font-stretch: inherit; font-size: 16px; line-height: inherit; font-family: inherit; vertical-align: baseline; cursor: text; counter-reset: list-1 0 list-2 0 list-3 0 list-4 0 list-5 0 list-6 0 list-7 0 list-8 0 list-9 0; background-color: rgb(240, 240, 240); border-radius: 3px; white-space: pre-wrap; color: rgb(34, 34, 34); letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">>>> Test.myfunc()
    in staticmethod get
    hello

    Test().myfunc()
    in staticmethod get
    hello
    复制代码
    </pre>

    1.17.4 基于描述符如何实现classmethod

    同样的 classmethod 也是一样。

    <pre spellcheck="false" style="box-sizing: border-box; margin: 5px 0px; padding: 5px 10px; border: 0px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-variant-numeric: inherit; font-variant-east-asian: inherit; font-weight: 400; font-stretch: inherit; font-size: 16px; line-height: inherit; font-family: inherit; vertical-align: baseline; cursor: text; counter-reset: list-1 0 list-2 0 list-3 0 list-4 0 list-5 0 list-6 0 list-7 0 list-8 0 list-9 0; background-color: rgb(240, 240, 240); border-radius: 3px; white-space: pre-wrap; color: rgb(34, 34, 34); letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">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)
    

    复制代码
    </pre>

    验证结果如下

    <pre spellcheck="false" style="box-sizing: border-box; margin: 5px 0px; padding: 5px 10px; border: 0px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-variant-numeric: inherit; font-variant-east-asian: inherit; font-weight: 400; font-stretch: inherit; font-size: 16px; line-height: inherit; font-family: inherit; vertical-align: baseline; cursor: text; counter-reset: list-1 0 list-2 0 list-3 0 list-4 0 list-5 0 list-6 0 list-7 0 list-8 0 list-9 0; background-color: rgb(240, 240, 240); border-radius: 3px; white-space: pre-wrap; color: rgb(34, 34, 34); letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">>>> Test.myfunc()
    in classmethod get
    hello

    Test().myfunc()
    in classmethod get
    hello
    复制代码
    </pre>

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

    相关文章

      网友评论

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

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