Python深入学习之装饰器


Posted in Python onAugust 31, 2014

装饰器(decorator)是一种高级Python语法。装饰器可以对一个函数、方法或者类进行加工。在Python中,我们有多种方法对函数和类进行加工,比如在Python闭包中,我们见到函数对象作为某一个函数的返回结果。相对于其它方式,装饰器语法简单,代码可读性高。因此,装饰器在Python项目中有广泛的应用。

装饰器最早在Python 2.5中出现,它最初被用于加工函数和方法这样的可调用对象(callable object,这样的对象定义有__call__方法)。在Python 2.6以及之后的Python版本中,装饰器被进一步用于加工类。

装饰函数和方法

我们先定义两个简单的数学函数,一个用来计算平方和,一个用来计算平方差:

# get square sum

def square_sum(a, b):

    return a**2 + b**2
# get square diff

def square_diff(a, b):

    return a**2 - b**2
print(square_sum(3, 4))

print(square_diff(3, 4))

在拥有了基本的数学功能之后,我们可能想为函数增加其它的功能,比如打印输入。我们可以改写函数来实现这一点:

# modify: print input
# get square sum

def square_sum(a, b):

    print("intput:", a, b)

    return a**2 + b**2
# get square diff

def square_diff(a, b):

    print("input", a, b)

    return a**2 - b**2
print(square_sum(3, 4))

print(square_diff(3, 4))

我们修改了函数的定义,为函数增加了功能。

现在,我们使用装饰器来实现上述修改:

def decorator(F):

    def new_F(a, b):

        print("input", a, b)

        return F(a, b)

    return new_F
# get square sum

@decorator

def square_sum(a, b):

    return a**2 + b**2
# get square diff

@decorator

def square_diff(a, b):

    return a**2 - b**2
print(square_sum(3, 4))

print(square_diff(3, 4))

装饰器可以用def的形式定义,如上面代码中的decorator。装饰器接收一个可调用对象作为输入参数,并返回一个新的可调用对象。装饰器新建了一个可调用对象,也就是上面的new_F。new_F中,我们增加了打印的功能,并通过调用F(a, b)来实现原有函数的功能。

定义好装饰器后,我们就可以通过@语法使用了。在函数square_sum和square_diff定义之前调用@decorator,我们实际上将square_sum或square_diff传递给decorator,并将decorator返回的新的可调用对象赋给原来的函数名(square_sum或square_diff)。 所以,当我们调用square_sum(3, 4)的时候,就相当于:

square_sum = decorator(square_sum)

square_sum(3, 4)

我们知道,Python中的变量名和对象是分离的。变量名可以指向任意一个对象。从本质上,装饰器起到的就是这样一个重新指向变量名的作用(name binding),让同一个变量名指向一个新返回的可调用对象,从而达到修改可调用对象的目的。

与加工函数类似,我们可以使用装饰器加工类的方法。

如果我们有其他的类似函数,我们可以继续调用decorator来修饰函数,而不用重复修改函数或者增加新的封装。这样,我们就提高了程序的可重复利用性,并增加了程序的可读性。

含参的装饰器

在上面的装饰器调用中,比如@decorator,该装饰器默认它后面的函数是唯一的参数。装饰器的语法允许我们调用decorator时,提供其它参数,比如@decorator(a)。这样,就为装饰器的编写和使用提供了更大的灵活性。

# a new wrapper layer

def pre_str(pre=''):

    # old decorator

    def decorator(F):

        def new_F(a, b):

            print(pre + "input", a, b)

            return F(a, b)

        return new_F

    return decorator
# get square sum

@pre_str('^_^')

def square_sum(a, b):

    return a**2 + b**2
# get square diff

@pre_str('T_T')

def square_diff(a, b):

    return a**2 - b**2
print(square_sum(3, 4))

print(square_diff(3, 4))

上面的pre_str是允许参数的装饰器。它实际上是对原有装饰器的一个函数封装,并返回一个装饰器。我们可以将它理解为一个含有环境参量的闭包。当我们使用@pre_str('^_^')调用的时候,Python能够发现这一层的封装,并把参数传递到装饰器的环境中。该调用相当于:
square_sum = pre_str('^_^') (square_sum)

装饰类

在上面的例子中,装饰器接收一个函数,并返回一个函数,从而起到加工函数的效果。在Python 2.6以后,装饰器被拓展到类。一个装饰器可以接收一个类,并返回一个类,从而起到加工类的效果。

def decorator(aClass):

    class newClass:

        def __init__(self, age):

            self.total_display   = 0

            self.wrapped         = aClass(age)

        def display(self):

            self.total_display += 1

            print("total display", self.total_display)

            self.wrapped.display()

    return newClass
@decorator

class Bird:

    def __init__(self, age):

        self.age = age

    def display(self):

        print("My age is",self.age)
eagleLord = Bird(5)

for i in range(3):

    eagleLord.display()

在decorator中,我们返回了一个新类newClass。在新类中,我们记录了原来类生成的对象(self.wrapped),并附加了新的属性total_display,用于记录调用display的次数。我们也同时更改了display方法。

通过修改,我们的Bird类可以显示调用display的次数了。

总结

装饰器的核心作用是name binding。这种语法是Python多编程范式的又一个体现。大部分Python用户都不怎么需要定义装饰器,但有可能会使用装饰器。鉴于装饰器在Python项目中的广泛使用,了解这一语法是非常有益的。

Python 相关文章推荐
Python实现多行注释的另类方法
Aug 22 Python
Python和GO语言实现的消息摘要算法示例
Mar 10 Python
python装饰器与递归算法详解
Feb 18 Python
Python实现二分查找与bisect模块详解
Jan 13 Python
老生常谈进程线程协程那些事儿
Jul 24 Python
python Matplotlib画图之调整字体大小的示例
Nov 20 Python
Django 缓存配置Redis使用详解
Jul 23 Python
pandas 如何分割字符的实现方法
Jul 29 Python
python 实现将Numpy数组保存为图像
Jan 09 Python
Python 3.8 新功能大揭秘【新手必学】
Feb 05 Python
Python3.7在anaconda里面使用IDLE编译器的步骤详解
Apr 29 Python
vscode写python时的代码错误提醒和自动格式化的方法
May 07 Python
Python深入学习之闭包
Aug 31 #Python
Python深入学习之对象的属性
Aug 31 #Python
Python深入学习之上下文管理器
Aug 31 #Python
Python深入学习之特殊方法与多范式
Aug 31 #Python
python中的reduce内建函数使用方法指南
Aug 31 #Python
Python中使用ConfigParser解析ini配置文件实例
Aug 30 #Python
python进阶教程之动态类型详解
Aug 30 #Python
You might like
使用apache模块rewrite_module (转)
2007/02/14 PHP
PHP错误机制知识汇总
2016/03/24 PHP
CI映射(加载)数据到view层的方法
2016/03/28 PHP
PHP实现的自定义图像居中裁剪函数示例【测试可用】
2017/08/11 PHP
thinkphp5+layui实现的分页样式示例
2019/10/08 PHP
laravel实现按月或天或小时统计mysql数据的方法
2019/10/09 PHP
Javascript中 关于prototype属性实现继承的原理图
2013/04/16 Javascript
jquery选择器-根据多个属性选择示例代码
2013/10/21 Javascript
用jQuery与JSONP轻松解决跨域访问的问题
2014/02/04 Javascript
js使用正则实现ReplaceAll全部替换的方法
2014/07/18 Javascript
详解jQuery中的deferred对象的使用(一)
2016/05/27 Javascript
jQuery遍历节点树方法分析
2016/09/08 Javascript
浅谈webpack4 图片处理汇总
2018/09/12 Javascript
Nodejs实现的操作MongoDB数据库功能完整示例
2019/02/02 NodeJs
ES6知识点整理之数组解构和字符串解构的应用示例
2019/04/17 Javascript
JS实现点击发送验证码 xx秒后重新发送功能
2019/07/30 Javascript
Vue 微信端扫描二维码苹果端却只能保存图片问题(解决方法)
2020/01/19 Javascript
Vue清除定时器setInterval优化方案分享
2020/07/21 Javascript
[01:20]2018DOTA2亚洲邀请赛总决赛战队Mineski晋级之路
2018/04/07 DOTA
浅析python中的分片与截断序列
2016/08/09 Python
Python爬取数据保存为Json格式的代码示例
2019/04/09 Python
python中remove函数的踩坑记录
2021/01/04 Python
英国在线购买轮胎、预订汽车、汽车维修和装配网站:Protyre
2020/04/12 全球购物
如何写毕业求职自荐信
2013/11/06 职场文书
大学生饮食连锁店创业计划书
2014/01/17 职场文书
高二生物教学反思
2014/01/27 职场文书
珠宝店促销方案
2014/03/21 职场文书
小学优秀班集体申报材料
2014/05/25 职场文书
公司年终奖分配方案
2014/06/16 职场文书
大学感恩节活动策划方案
2014/10/11 职场文书
计算机实训报告总结
2014/11/05 职场文书
企业介绍信范文
2015/01/30 职场文书
自主招生自荐信怎么写
2015/03/24 职场文书
2015年实习生工作总结报告
2015/04/28 职场文书
晚会主持人开场白台词
2015/05/28 职场文书
Java中的Kotlin 内部类原理
2022/06/16 Java/Android