Python装饰器的另类用法

hqman 发布于2019-07-31 10:52 / 3343人阅读

摘要：今天我们一起探讨一下装饰器的另类用法。语法回顾开始之前我们再将装饰器的语法回顾一下。例子本身只是演示了装饰器的一种用法，但不是推荐你就这样使用装饰器。类装饰器在以前，还不支持类装饰器。

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

语法回顾

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

@decorate
def f(...):
    pass

等同于:

def f(...):
    pass

f = decorate(f)

@语法的好处在于：

相同的函数名只出现一次，避免了f = decorate(f)这样的语句。

可读性更高，让读代码的人一眼就明白函数被装饰了哪些功能。

@call()装饰器

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

>>> table = [0, 1, 4, 9, 16]
>>> len(table), table[3]
(5, 9)

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

>>> table = [i * i for i in range(5)]
>>> len(table), table[3]
(5, 9)

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

>>> def table(n):
...     value = []
...     for i in range(n):
...         value.append(i*i)
...     return value
>>> table = table(5)

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

你需要把相对复杂业务写成一个方法。

这个方法和返回值可以同名，而且你不希望对外公开此方法，只公开结果。

你想尽量使用装饰器。（无厘头的理由）

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

def call(*args, **kwargs):
    def call_fn(fn):
        return fn(*args, **kwargs)
    return call_fn

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

@call(5)
def table(n):
    value = []
    for i in range(n):
        value.append(i*i)
    return value

print len(table), table[3]  # 5 9

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

@list 装饰器

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

def table(n):
    for i in range(n):
        yield i

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

table = table(5)
print table  #

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

@call(5)
def table(n):
    for i in range(n):
        yield i

print table  #

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

@list
@call(5)
def table(n):
    for i in range(n):
        yield i

print table  # [0, 1, 2, 3, 4]

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

类装饰器

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

@decorator
class MyClass(object):
    pass

你必须这样写：

class MyClass(object):
    pass

MyClass = decorator(MyClass)

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

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

def TestClass(enabled=True, run_mode="singleline"):
    def tracer(cls):
        cls.__pd_type__ ="test"
        cls.__enabled__ = enabled
        cls.__run_mode__ = run_mode.lower()
        return cls
    return tracer

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

@TestClass()
class TestCases(object):
    # your test case ...

print TestCases.__dict__  # {"__module__": "__main__", "__enabled__": True, "__pd_type__": "test", "__run_mode__": "singleline", ...}

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

class TestCases(object):
    pass

decorator = TestClass()
print decorator  # 

TestCases = decorator(TestCases)
print TestCases  # 

print TestCases.__dict__  # {"__module__": "__main__", "__enabled__": True, "__pd_type__": "test", "__run_mode__": "singleline", ...}

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

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

后记

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

关于作者：Python技术爱好者，目前从事测试开发相关工作，转载请注明原文出处。

欢迎关注我的博客 http://betacat.online，你可以到我的公众号中去当吃瓜群众。

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/44238.html

Python学习之路26-函数装饰器和闭包

摘要：初步认识装饰器函数装饰器用于在源代码中标记函数，以某种方式增强函数的行为。函数装饰器在导入模块时立即执行，而被装饰的函数只在明确调用时运行。只有涉及嵌套函数时才有闭包问题。如果想保留函数原本的属性，可以使用标准库中的装饰器。《流畅的Python》笔记本篇将从最简单的装饰器开始，逐渐深入到闭包的概念，然后实现参数化装饰器，最后介绍标准库中常用的装饰器。 1. 初步认识装饰器函数装饰...

sunny5541 2019-07-30 16:45 评论0 收藏0
python高级特性

摘要：常规的使用来统计一段代码运行时间的例子输出结果总结其实是一门特别人性化的语言，但凡在工程中经常遇到的问题，处理起来比较棘手的模式基本都有对应的比较优雅的解决方案。 python的高级特性名词与翻译对照表 generator 生成器 iterator 迭代器 collection 集合 pack/unpack 打包/解包 decorator 装饰器 context manager ...

yexiaobai 2019-07-30 14:19 评论0 收藏0
【Python】一文弄懂python装饰器（附源码例子）

摘要：装饰器的使用符合了面向对象编程的开放封闭原则。三简单的装饰器基于上面的函数执行时间的需求，我们就手写一个简单的装饰器进行实现。函数体就是要实现装饰器的内容。类装饰器的实现是调用了类里面的函数。类装饰器的写法比我们装饰器函数的写法更加简单。目录前言一、什么是装饰器二、为什么要用装饰器 ...

liuchengxu 2021-09-04 16:40 评论0 收藏0
每天一个设计模式之装饰者模式

摘要：作者按每天一个设计模式旨在初步领会设计模式的精髓，目前采用和两种语言实现。诚然，每种设计模式都有多种实现方式，但此小册只记录最直截了当的实现方式原文地址是每天一个设计模式之装饰者模式欢迎关注个人技术博客。作者按：《每天一个设计模式》旨在初步领会设计模式的精髓，目前采用javascript和python两种语言实现。诚然，每种设计模式都有多种实现方式，但此小册只记录最直截了当的实现方式...

brianway 2019-08-23 14:56 评论0 收藏0
每天一个设计模式之装饰者模式

摘要：作者按每天一个设计模式旨在初步领会设计模式的精髓，目前采用和两种语言实现。诚然，每种设计模式都有多种实现方式，但此小册只记录最直截了当的实现方式原文地址是每天一个设计模式之装饰者模式欢迎关注个人技术博客。作者按：《每天一个设计模式》旨在初步领会设计模式的精髓，目前采用javascript和python两种语言实现。诚然，每种设计模式都有多种实现方式，但此小册只记录最直截了当的实现方式...

shleyZ 2019-07-31 09:59 评论0 收藏0