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中sets模块的用法实例
Sep 30 Python
Python连接mssql数据库编码问题解决方法
Jan 01 Python
在Django的URLconf中使用多个视图前缀的方法
Jul 18 Python
从局部变量和全局变量开始全面解析Python中变量的作用域
Jun 16 Python
Python利用BeautifulSoup解析Html的方法示例
Jul 30 Python
python中urlparse模块介绍与使用示例
Nov 19 Python
python调用xlsxwriter创建xlsx的方法
May 03 Python
Python 中Django验证码功能的实现代码
Jun 20 Python
浅谈python累加求和+奇偶数求和_break_continue
Feb 25 Python
Django 用户登陆访问限制实例 @login_required
May 13 Python
宝塔面板成功部署Django项目流程(图文)
Jun 22 Python
python 牛顿法实现逻辑回归(Logistic Regression)
Oct 15 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
落伍首发 php+mysql 采用ajax技术的 省 市 地 3级联动无刷新菜单 源码
2006/12/16 PHP
PHP获取远程图片并保存到本地的方法
2015/05/12 PHP
php无序树实现方法
2015/07/28 PHP
js弹窗代码 可以指定弹出间隔
2010/07/03 Javascript
DOM_window对象属性之--clipboardData对象操作代码
2011/02/03 Javascript
获得所有表单值的JQuery实现代码[IE暂不支持]
2012/05/24 Javascript
javascript获取作用在元素上面的样式属性代码
2012/09/20 Javascript
JS 各种网页尺寸判断实例方法
2013/04/18 Javascript
手机端网页点击链接触发自动拨打或保存电话的示例代码
2014/08/15 Javascript
javascript跑马灯抽奖实例讲解
2020/04/17 Javascript
JavaScript开发Chrome浏览器扩展程序UI的教程
2016/05/16 Javascript
vue.js初学入门教程(2)
2016/11/07 Javascript
jQuery zTree树插件简单使用教程
2017/01/10 Javascript
Vue一个案例引发的递归组件的使用详解
2018/11/15 Javascript
小程序实现左滑删除效果
2019/07/25 Javascript
创建nuxt.js项目流程图解
2020/03/13 Javascript
从零学Python之hello world
2014/05/21 Python
Python中模块与包有相同名字的处理方法
2017/05/05 Python
Python读取数据集并消除数据中的空行方法
2018/07/12 Python
对Python发送带header的http请求方法详解
2019/01/02 Python
详解从Django Rest Framework响应中删除空字段
2019/01/11 Python
Python threading的使用方法解析
2019/08/28 Python
python读取ini配置文件过程示范
2019/12/23 Python
python删除某个目录文件夹的方法
2020/05/26 Python
python与idea的集成的实现
2020/11/20 Python
Python 调用 ES、Solr、Phoenix的示例代码
2020/11/23 Python
Vans(范斯)新西兰官方网站:美国原创极限运动品牌
2020/09/19 全球购物
巴西最大的运动品牌:Olympikus
2020/07/14 全球购物
【魔兽争霸3重制版】原版画面与淬火MOD画面对比
2021/03/26 魔兽争霸
行政经理岗位职责
2013/11/09 职场文书
创先争优承诺书范文
2014/03/31 职场文书
公司大门门卫岗位职责
2014/06/11 职场文书
邹越感恩父母演讲稿
2014/08/28 职场文书
泰坦尼克号观后感
2015/06/04 职场文书
pytorch实现线性回归以及多元回归
2021/04/11 Python
C#连接ORACLE出现乱码问题的解决方法
2021/10/05 Oracle