Python装饰器新玩法

3,473次阅读
没有评论

之前有比较系统介绍过Python的装饰器(请查阅《详解Python装饰器》),本文算是一个补充。今天我们一起探讨一下装饰器的另类用法。

语法回顾

开始之前我们再将Python装饰器的语法回顾一下。

<span class="hljs-decorator">@decorate</span>
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(...)</span>:</span>
    <span class="hljs-keyword">pass</span>

等同于:

<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">f</span><span class="hljs-params">(...)</span>:</span>
    <span class="hljs-keyword">pass</span>

f = decorate(f)

@语法的好处在于:

  • 相同的函数名只出现一次,避免了f = decorate(f)这样的语句。
  • 可读性更高,让读代码的人一眼就明白函数被装饰了哪些功能。

@call()装饰器

假设你要创建一个整数平方的列表,你可以这样写:

<span class="hljs-prompt">>>> </span>table = [<span class="hljs-number">0</span>, <span class="hljs-number">1</span>, <span class="hljs-number">4</span>, <span class="hljs-number">9</span>, <span class="hljs-number">16</span>]
<span class="hljs-prompt">>>> </span>len(table), table[<span class="hljs-number">3</span>]
(<span class="hljs-number">5</span>, <span class="hljs-number">9</span>)

也可以使用列表表达式,因为我们要实现比较简单。

<span class="hljs-prompt">>>> </span>table = [i * i <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(<span class="hljs-number">5</span>)]
<span class="hljs-prompt">>>> </span>len(table), table[<span class="hljs-number">3</span>]
(<span class="hljs-number">5</span>, <span class="hljs-number">9</span>)

但是假如这个列表的逻辑比较复杂的时候,最好是写成一个方法,这样会更好维护。

<span class="hljs-prompt">>>> </span><span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">table</span><span class="hljs-params">(n)</span>:</span>
<span class="hljs-prompt">... </span>    value = []
<span class="hljs-prompt">... </span>    <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(n):
<span class="hljs-prompt">... </span>        value.append(i*i)
<span class="hljs-prompt">... </span>    <span class="hljs-keyword">return</span> value
<span class="hljs-prompt">>>> </span>table = table(<span class="hljs-number">5</span>)

注意看最后一句,是不是很符合装饰器的语法规则?什么情况下你会写这样的代码呢?

  1. 你需要把相对复杂业务写成一个方法。
  2. 这个方法和返回值可以同名,而且你不希望对外公开此方法,只公开结果。
  3. 你想尽量使用装饰器。(无厘头的理由)

那么这时候@call()装饰器就登场了。

<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">call</span><span class="hljs-params">(*args, **kwargs)</span>:</span>
    <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">call_fn</span><span class="hljs-params">(fn)</span>:</span>
        <span class="hljs-keyword">return</span> fn(*args, **kwargs)
    <span class="hljs-keyword">return</span> call_fn

这个装饰器会把你传入的参数送给目标函数然后直接执行

<span class="hljs-decorator">@call(5)</span>
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">table</span><span class="hljs-params">(n)</span>:</span>
    value = []
    <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(n):
        value.append(i*i)
    <span class="hljs-keyword">return</span> value

<span class="hljs-keyword">print</span> len(table), table[<span class="hljs-number">3</span>]  <span class="hljs-comment"># 5 9</span>

@call()装饰器适用于任何函数,你传入的参数会被直接使用然后结果赋值给同名函数。这样避免了你重新定义一个变量来存储结果。

@list 装饰器

假如你有一个这样一个生成器函数。

<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">table</span><span class="hljs-params">(n)</span>:</span>
    <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(n):
        <span class="hljs-keyword">yield</span> i

当你要生成n=5的序列时,可以直接调用。

table = table(<span class="hljs-number">5</span>)
<span class="hljs-keyword">print</span> table  <span class="hljs-comment"># <generator object table at 0x027DAC10></span>

使用上节提到的@call()装饰器,也能得到一样的结果。

<span class="hljs-decorator">@call(5)</span>
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">table</span><span class="hljs-params">(n)</span>:</span>
    <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(n):
        <span class="hljs-keyword">yield</span> i

<span class="hljs-keyword">print</span> table  <span class="hljs-comment"># <generator object table at 0x0340AC10></span>

你还可以直接将其转换成列表。(使用list(generator_object)函数)

<span class="hljs-decorator">@list</span>
<span class="hljs-decorator">@call(5)</span>
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">table</span><span class="hljs-params">(n)</span>:</span>
    <span class="hljs-keyword">for</span> i <span class="hljs-keyword">in</span> range(n):
        <span class="hljs-keyword">yield</span> i

<span class="hljs-keyword">print</span> table  <span class="hljs-comment"># [0, 1, 2, 3, 4]</span>

相信不少同学第一次看到这个用法应该是懵逼的。这等同于列表表达式,但是可读性也许差了不少。例子本身只是演示了装饰器的一种用法,但不是推荐你就这样使用装饰器。你这样用也许会被其他同事拖到墙角里打死。

类装饰器

在Python 2.6以前,还不支持类装饰器。也就是说,你不能使用这样的写法。

<span class="hljs-decorator">@decorator</span>
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyClass</span><span class="hljs-params">(object)</span>:</span>
    <span class="hljs-keyword">pass</span>

你必须这样写:

<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyClass</span><span class="hljs-params">(object)</span>:</span>
    <span class="hljs-keyword">pass</span>

MyClass = decorator(MyClass)

也就是说,@语法对类是做了特殊处理的,类不一定是一个callable对象(尽管它有构造函数),但是也允许使用装饰器。那么基于以上语法,你觉得类装饰器能实现什么功能呢?

举一个例子,ptest中的@TestClass()用于声明一个测试类,其源代码大致如此。

<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">TestClass</span><span class="hljs-params">(enabled=True, run_mode=<span class="hljs-string">"singleline"</span>)</span>:</span>
    <span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">tracer</span><span class="hljs-params">(cls)</span>:</span>
        cls.__pd_type__ =<span class="hljs-string">'test'</span>
        cls.__enabled__ = enabled
        cls.__run_mode__ = run_mode.lower()
        <span class="hljs-keyword">return</span> cls
    <span class="hljs-keyword">return</span> tracer

当我们在写一个测试类时,发生了什么?

<span class="hljs-decorator">@TestClass()</span>
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">TestCases</span><span class="hljs-params">(object)</span>:</span>
    <span class="hljs-comment"># your test case ...</span>

<span class="hljs-keyword">print</span> TestCases.__dict__  <span class="hljs-comment"># {'__module__': '__main__', '__enabled__': True, '__pd_type__': 'test', '__run_mode__': 'singleline', ...}</span>

居然装饰器的参数全都变成了变成这个类的属性,好神奇!我们把语法糖一一展开。

<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">TestCases</span><span class="hljs-params">(object)</span>:</span>
    <span class="hljs-keyword">pass</span>

decorator = TestClass()
<span class="hljs-keyword">print</span> decorator  <span class="hljs-comment"># <function tracer at 0x033128F0></span>

TestCases = decorator(TestCases)
<span class="hljs-keyword">print</span> TestCases  <span class="hljs-comment"># <class '__main__.TestCases'></span>

<span class="hljs-keyword">print</span> TestCases.__dict__  <span class="hljs-comment"># {'__module__': '__main__', '__enabled__': True, '__pd_type__': 'test', '__run_mode__': 'singleline', ...}</span>

当装饰器在被使用时,TestClass()函数会马上被执行并返回一个装饰器函数,这个函数是一个闭包函数,保存了enabledrun_mode两个变量。另外它还接受一个类作为参数,并使用之前保存的变量为这个类添加属性,最后返回。所以经过@TestClass()装饰过的类都会带上__enabled____pd_type__以及__run_mode__的属性。

由此可见,类装饰器可以完成和Java类似的注解功能,而且要比注解强大的多。

后记

装饰器就是一个语法糖,当你看不懂一个装饰器时,可以考虑将其依次展开,分别带入。这个语法糖给了我们不少方便,但是也要慎用。毕竟可维护的代码才是高质量的代码。

admin
版权声明:本站原创文章,由admin2016-11-07发表,共计2589字。
转载提示:除特殊说明外本站文章皆由CC-4.0协议发布,转载请注明出处。
评论(没有评论)