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运算符重载用法实例
May 28 Python
纯用NumPy实现神经网络的示例代码
Oct 24 Python
用pycharm开发django项目示例代码
Jun 13 Python
python读写csv文件方法详细总结
Jul 05 Python
用python建立两个Y轴的XY曲线图方法
Jul 08 Python
python用requests实现http请求代码实例
Oct 31 Python
Python猜数字算法题详解
Mar 01 Python
Python requests模块安装及使用教程图解
Jun 30 Python
Python 制作查询商品历史价格的小工具
Oct 20 Python
几款好用的python工具库(小结)
Oct 20 Python
总结python多进程multiprocessing的相关知识
Jun 29 Python
关于pytest结合csv模块实现csv格式的数据驱动问题
May 30 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
zf框架的db类select查询器join链表使用示例(zend框架)
2014/03/14 PHP
Django中的cookie与session操作实例代码
2017/08/17 PHP
PHP实现支持CURL字符串证书传输的方法
2019/03/23 PHP
javascript 模拟JQuery的Ready方法实现并出现的问题
2009/12/06 Javascript
jquery插件之easing 动态菜单
2010/08/21 Javascript
jQuery学习笔记[1] jQuery中的DOM操作
2010/12/03 Javascript
javascript中callee与caller的用法和应用场景
2010/12/08 Javascript
jquery1.83 之前所有与异步列队相关的模块详细介绍
2012/11/13 Javascript
js 利用image对象实现图片的预加载提高访问速度
2013/03/29 Javascript
jQuery拖动图片删除示例
2013/05/10 Javascript
Node.js插件的正确编写方式
2014/08/03 Javascript
node.js中的fs.stat方法使用说明
2014/12/16 Javascript
jQuery在ul中显示某个li索引号的方法
2015/03/17 Javascript
创建自己的jquery表格插件
2015/11/25 Javascript
表单元素值获取方式js及java方式的简单实例
2016/10/15 Javascript
Angular 4依赖注入学习教程之InjectToken的使用(八)
2017/06/04 Javascript
原生js实现移动端触摸轮播的示例代码
2017/12/22 Javascript
vue中element-ui表格缩略图悬浮放大功能的实例代码
2018/06/26 Javascript
总结4个方面优化Vue项目
2019/02/11 Javascript
VUE的history模式下除了index外其他路由404报错解决办法
2019/08/21 Javascript
Python实现的文本简单可逆加密算法示例
2017/05/18 Python
python 把文件中的每一行以数组的元素放入数组中的方法
2018/04/29 Python
python超时重新请求解决方案
2019/10/21 Python
在django中自定义字段Field详解
2019/12/03 Python
Python 格式化输出_String Formatting_控制小数点位数的实例详解
2020/02/04 Python
python mysql 字段与关键字冲突的解决方式
2020/03/02 Python
德国旅游网站:weg.de
2018/06/03 全球购物
英国电子产品购物网站:Tech in the basket
2019/11/08 全球购物
如何配置、使用和清除Smarty缓存
2015/12/23 面试题
公司授权委托书范本
2014/04/03 职场文书
医疗专业毕业生求职信
2014/08/28 职场文书
2014年度考核工作总结
2014/12/24 职场文书
大学生支教感言
2015/08/01 职场文书
为什么你写的height:100%不起作用
2021/05/10 HTML / CSS
Pytorch GPU内存占用很高,但是利用率很低如何解决
2021/06/01 Python
分享mysql的current_timestamp小坑及解决
2021/11/27 MySQL