【Python】浅谈装饰器

简介: 一 装饰器是什么    装饰器是一个用于封装函数或者类的代码工具,显式地将封装器作用于函数或者类上,达到程序运行时动态增加功能的目的。对于函数运行前处理常见前置条件(常见的web登陆授权验证),或者在函数执行之后做善后工作(比如异常处理,记录log 等等)。
一 装饰器是什么
   装饰器是一个用于封装函数或者类的代码工具,显式地将封装器作用于函数或者类上,达到程序运行时动态增加功能的目的。对于函数运行前处理常见前置条件(常见的web登陆授权验证),或者在函数执行之后做善后工作(比如异常处理,记录log 等等)。

二 如何使用装饰器
   装饰器本质上就是一个可用接受调用也可以返回调用的高阶函数。该函数以被装饰的函数为参数(还可以加上其他值作为参数)。在装饰器内进行装饰器的逻辑处理,执行被装饰函数,并返回一个装饰过的函数,听起来是不是有点绕,Talk is cheap,show me the code . 
本文使用函数now 和函数add作为例子,
  1. import datetime
  2. def now():
  3.     print 'now is ', datetime.datetime.today()
  4. def add(x, y):
  5.     ret = x + y
  6.     print '{x} + {y} = {retval}'.format(x=x,y=y,retval=ret)
2.1 装饰器语法
   有两种方式显示调用装饰器的方法。
   方法一:func = deco(func)
   方法二:Python 2.5之后 为装饰器引入了特殊的语法 @ --语法糖,在装饰器名称前使用@ 符号,添加在被装饰的函数定义之前。 
  1. @deco
  2.    def now():
  3.        print 'now is ', datetime.datetime.today()
  4.    # 调用now
  5.    now()
本文将从 参数这个角度来由浅入深介绍装饰器,函数有不带参数和带参数的两种情况,装饰器也有带参数和不带参数的两种情况,装饰器对处理带参数和不带参数的情况也会有锁不同。
2.2 不带参数的情况
  我们需要在调用函数 now 之前和之后加上调用记录。
  1. def deco(func):
  2.     print 'begin call %s():' % (func.__name__)
  3.     func()
  4.     print 'end call %s():' % (func.__name__)
  5.     return func #装饰器的参数是被装饰的函数对象,返回原函数的对象。
  1. yangyiDBA:test yangyi$ python 1.py
  2. begin call now():
  3. now is 2017-05-01 14:40:57.309836
  4. end call now():
  5. now is 2017-05-01 14:40:57.309868
但是从上面的例子看 结果输出了两次now 时间,明显不符合我们的要求,因为装饰器必须返回被调用函数,return func的时候发生了第二次。后面我们会解决这个问题。
2.3 带参数的情况,因为函数的参数个数是不确定的 ,我们需要借助 (*args, **kwargs),自动适应变参和命名参数。
  1. #!/usr/bin/env python
  2. # coding:utf-8
  3. import datetime
  4. import functools
  5. def deco(func):
  6.     @functools.wraps(func) #
  7.     def wrapper(*args, **kw):
  8.         print 'begin call %s():' % (func.__name__)
  9.         result=func(*args, **kw) # 如果函数无返回值 ,可以直接使用func(*args, **kw)
  10.         print 'end call %s():' % (func.__name__)
  11.         return result #这里 result 是为了func 有返回值,
  12.     return wrapper
  13. @deco
  14. def add(x, y):
  15.     ret = x + y
  16.     print '{x} + {y} = {retval}'.format(x=x,y=y,retval=ret)
  17. @deco
  18. def now():
  19.     print 'now is ', datetime.datetime.today()
  20. add(2,5)
  21. now()
上面的装饰器做了如下事情
1 函数func作为参数传给 deco()。
2 functool.wraps 将func 的属性复制给 warper。
3 执行函数func前后执行某些动作。
4 返回结果。
5 返回wrapper 函数对象。
这里特别说明functool.wraps的作用,由于装饰器导致解释器认为函数本身发生了改变,在某些情况下可能会导致一些问题。Python通过functool.wraps解决了这个问题:
在编写装饰器时,在实现前加入 @functools.wraps(func) 可以保证装饰器不会对被装饰函数造成影响。
特别说明其他要使用装饰器的时候会有其他的写法 比如直接返回被装饰的函数。
  1. def deco(func):
  2.     @functools.wraps(func) #
  3.     def wrapper(*args, **kw):
  4.         print 'begin call %s():' % (func.__name__)
  5.         return func(*args, **kw)
  6.     return wrapper
输出
  1. yangyiDBA:test yangyi$ python 1.py
  2. begin call add():
  3. 2 + 5 = 7
  4. end call add():
  5. begin call now():
  6. now is 2017-05-01 15:20:51.597859
  7. end call now():
2.4 带参数的装饰器 
如果装饰器本身传入参数,就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义log的文本:
  1. #!/usr/bin/env python
  2. # coding:utf-8
  3. import datetime
  4. import functools
  5. def deco(text):
  6.     def _deco(func):
  7.         def wrapper(*args, **kw):
  8.             print '%s, begin call %s():' % (text,func.__name__)
  9.             result=func(*args, **kw) # 如果函数无返回值 ,可以直接使用func(*args, **kw)
  10.             print '%s, end call %s():' % (text,func.__name__)
  11.             return result #这里 result 是为了func 有返回值,
  12.         return wrapper
  13.     return _deco
  14. @deco("yangyi")
  15. def add(x, y):
  16.     ret = x + y
  17.     print '{x} + {y} = {retval}'.format(x=x,y=y,retval=ret)
  18. @deco("youzan")
  19. def now():
  20.     print 'now is ', datetime.datetime.today()
  21. add(2,5)
  22. now()
测试结果:
  1. yangyiDBA:test yangyi$ python 2.py
  2. yangyi, begin call add():
  3. 2 + 5 = 7
  4. yangyi, end call add():

  5. youzan, begin call now():
  6. now is 2017-05-01 18:47:54.728296
  7. youzan, end call now():
2.5 Python内置装饰器
在Python中有三个内置的装饰器,都是跟class相关的:staticmethod、classmethod 和property。
staticmethod 是类静态方法,其跟成员方法的区别是没有 self 参数,并且可以在类不进行实例化的情况下调用
classmethod  与成员方法的区别在于所接收的第一个参数不是 self (类实例的指针),而是cls(当前类的具体类型)
property 是属性的意思,表示可以通过通过类实例直接访问的信息

2.6 跨文件调用,因为装饰器本质是一个函数。在工程实现里我们可以通过创建一个公用的decorator,作为基础装饰器供其他函数调用。
 
三 小结
   Python一切皆对象,函数也是,也可以赋值给其他变量,理解这点再去理解装饰器就容易多了。 刚刚研究装饰器,总结的可能比较浅显,想要深入学习装饰器的可以看看下面的 参考文章。

四 参考文章
1 《Python高级编程》 第一章装饰器
2 《 装饰器
3   Python装饰器学习(九步入门)  
4   《详解Python的装饰器》
目录
相关文章
|
7天前
|
Python
深入理解Python装饰器:从入门到实践####
本文旨在通过简明扼要的方式,为读者揭开Python装饰器的神秘面纱,从基本概念、工作原理到实际应用场景进行全面解析。不同于常规的摘要仅概述内容概要,本文将直接以一段精炼代码示例开篇,展示装饰器如何优雅地增强函数功能,激发读者探索兴趣,随后深入探讨其背后的机制与高级用法。 ####
37 11
|
4天前
|
设计模式 缓存 开发者
深入浅出Python装饰器
【10月更文挑战第39天】本文将通过浅显易懂的语言和生动的比喻,带你探索Python中一个神奇而又强大的特性——装饰器。我们将一起揭开装饰器的神秘面纱,了解它的工作原理,并通过实际代码示例学习如何应用它来美化我们的代码。无论你是编程新手还是有经验的开发者,这篇文章都将为你打开一扇新的大门,让你的代码更加优雅和高效。
|
3天前
|
缓存 测试技术 数据库
深入理解Python中的装饰器
在本文中,我们将探讨Python语言中一个强大而灵活的特性——装饰器。装饰器允许开发者在不修改原有函数或方法代码的情况下增加额外的功能,这大大提高了代码的复用性和可读性。通过具体示例和应用场景的讲解,本篇文章旨在为读者提供一个关于如何使用装饰器的全面指南,包括装饰器的定义、使用场景、以及如何自定义装饰器等内容。
|
8天前
|
设计模式 Python
掌握Python中的装饰器
【10月更文挑战第34天】装饰器是Python中一种强大的工具,它允许我们在不修改原函数代码的情况下增加其功能。本文通过简单易懂的语言和实例,引导你理解装饰器的概念、种类及其应用,帮助你在编程实践中灵活使用这一高级特性。
|
4天前
|
缓存 监控 测试技术
Python中的装饰器:功能扩展与代码复用的利器###
本文深入探讨了Python中装饰器的概念、实现机制及其在实际开发中的应用价值。通过生动的实例和详尽的解释,文章展示了装饰器如何增强函数功能、提升代码可读性和维护性,并鼓励读者在项目中灵活运用这一强大的语言特性。 ###
|
7天前
|
缓存 开发者 Python
探索Python中的装饰器:简化代码,增强功能
【10月更文挑战第35天】装饰器在Python中是一种强大的工具,它允许开发者在不修改原有函数代码的情况下增加额外的功能。本文旨在通过简明的语言和实际的编码示例,带领读者理解装饰器的概念、用法及其在实际编程场景中的应用,从而提升代码的可读性和复用性。
|
3天前
|
设计模式 缓存 开发框架
Python中的装饰器:从入门到实践####
本文深入探讨了Python中装饰器的工作原理与应用,通过具体案例展示了如何利用装饰器增强函数功能、提高代码复用性和可读性。读者将学习到装饰器的基本概念、实现方法及其在实际项目开发中的实用技巧。 ####
15 3
|
4天前
|
Python
探索Python中的装饰器:简化代码,提升效率
【10月更文挑战第39天】在编程的世界中,我们总是在寻找使代码更简洁、更高效的方法。Python的装饰器提供了一种强大的工具,能够让我们做到这一点。本文将深入探讨装饰器的基本概念,展示如何通过它们来增强函数的功能,同时保持代码的整洁性。我们将从基础开始,逐步深入到装饰器的高级用法,让你了解如何利用这一特性来优化你的Python代码。准备好让你的代码变得更加优雅和强大了吗?让我们开始吧!
12 1
|
9天前
|
设计模式 缓存 监控
Python中的装饰器:代码的魔法增强剂
在Python编程中,装饰器是一种强大而灵活的工具,它允许程序员在不修改函数或方法源代码的情况下增加额外的功能。本文将探讨装饰器的定义、工作原理以及如何通过自定义和标准库中的装饰器来优化代码结构和提高开发效率。通过实例演示,我们将深入了解装饰器的应用,包括日志记录、性能测量、事务处理等常见场景。此外,我们还将讨论装饰器的高级用法,如带参数的装饰器和类装饰器,为读者提供全面的装饰器使用指南。
|
4天前
|
存储 缓存 监控
掌握Python装饰器:提升代码复用性与可读性的利器
在本文中,我们将深入探讨Python装饰器的概念、工作原理以及如何有效地应用它们来增强代码的可读性和复用性。不同于传统的函数调用,装饰器提供了一种优雅的方式来修改或扩展函数的行为,而无需直接修改原始函数代码。通过实际示例和应用场景分析,本文旨在帮助读者理解装饰器的实用性,并鼓励在日常编程实践中灵活运用这一强大特性。