浅尝装饰器和AOP

2023-06-14,,

【写在前面】

参考文章:https://www.cnblogs.com/huxi/archive/2011/03/01/1967600.html【从简单的例子入手进行讲解,由浅入深,很到位】

装饰器部分总共写了三篇博客,这是其一,另外两篇博客如下,都是比较浅显的记录的自己对装饰器的理解,感兴趣的可以踩一踩^_^

浅尝装饰器-@staticmethod 和@classmethod

浅尝装饰器--property装饰器

【正文部分】

  装饰器是一个很著名的设计模式,经常被用于有切面需求的场景,较为经典的有插入日志、性能测试、事务处理等。装饰器是解决这类问题的绝佳设计,有了装饰器,我们就可以抽离出函数中大量与函数功能本身无关的雷同代码并继续重用。概括的讲,装饰器的作用就是为已经存在的对象添加额外的功能

  在下面的第一个例子中,函数进入和退出时需要计时,这被称为一个横切面(Aspect),这种编程方式被称为面向切面的编程(Aspect-Oriented Programming)。与传统编程习惯的从上往下执行方式相比较而言,像是在函数执行的流程中横向地插入了一段逻辑。在特定的业务领域里,能减少大量重复代码。

  下面的讲解和代码是直接拿取参考文章里面的,并进行了小幅改动。

1. 语法糖@

  Python于是提供了一个语法糖来降低字符输入量。

# 备注:源代码使用的是time.clock()进行计时,猜测原博主使用的大概是Py2的环境,
# 我的是3.7,源码进行测试的时候print需要进行更改,提示警告clock()在后面的
# Py版本中会删掉,推荐使用下面的perf_counter()方法
import time def timeit(func):
def wrapper():
start = time.perf_counter()
func()
end = time.perf_counter()
print('used:', end - start)
return wrapper @timeit
def foo():
print('in foo()') foo()

  重点关注第11行的@timeit,在定义上加上这一行与另外写foo = timeit(foo)完全等价,千万不要以为@有另外的魔力。除了字符输入少了一些,还有一个额外的好处:这样看上去更有装饰器的感觉。

  【自己的理解:将foo函数作为timeit的参数进行传递】

2. 内置的装饰器

  内置的装饰器有三个,分别是staticmethod、classmethod和property,作用分别是把类中定义的实例方法变成静态方法、类方法和类属性。由于模块里可以定义函数,所以静态方法和类方法的用处并不是太多,除非你想要完全的面向对象编程。而属性也不是不可或缺的,Java没有属性也一样活得很滋润。从我个人的Python经验来看,我没有使用过property,使用staticmethod和classmethod的频率也非常低。

  【自己的理解:说到装饰器感觉很陌生,原来是自己前面接触到python基础知识里面的静态方法和类方法就是一种装饰器,可以参考浅尝装饰器-@staticmethod 和@classmethod了解staticmethod、classmethod,参考浅尝装饰器--property装饰器了解property装饰器】

class Rabbit(object):

    def __init__(self, name):
self._name = name @staticmethod
def newRabbit(name):
return Rabbit(name) @classmethod
def newRabbit2(cls):
return Rabbit('') @property
def name(self):
return self._name

  这里定义的属性是一个只读属性,如果需要可写,则需要再定义一个setter:

@name.setter
def name(self, name):
self._name = name

3. functools模块

  functools模块提供了两个装饰器。这个模块是Python 2.5后新增的,一般来说大家用的应该都高于这个版本。

3.1. wraps(wrapped[, assigned][, updated]): 

  这是一个很有用的装饰器。看过前一篇反射的朋友应该知道,函数是有几个特殊属性比如函数名,在被装饰后,上例中的函数名foo会变成包装函数的名字wrapper,如果你希望使用反射,可能会导致意外的结果。这个装饰器可以解决这个问题,它能将装饰过的函数的特殊属性保留。

 1 import time
2 import functools
3
4 def timeit(func):
5 @functools.wraps(func)
6 def wrapper():
7 start = time.clock()
8 func()
9 end =time.clock()
10 print 'used:', end - start
11 return wrapper
12
13 @timeit
14 def foo():
15 print 'in foo()'
16
17 foo()
18 print foo.__name__

  首先注意第5行,如果注释这一行,foo.__name__将是'wrapper'。另外相信你也注意到了,这个装饰器竟然带有一个参数。实际上,他还有另外两个可选的参数,assigned中的属性名将使用赋值的方式替换,而updated中的属性名将使用update的方式合并,你可以通过查看functools的源代码获得它们的默认值。对于这个装饰器,相当于wrapper = functools.wraps(func)(wrapper)。

3.2. total_ordering(cls): 

  这个装饰器在特定的场合有一定用处,但是它是在Python 2.7后新增的。它的作用是为实现了至少__lt__、__le__、__gt__、__ge__其中一个的类加上其他的比较方法,这是一个类装饰器。如果觉得不好理解,不妨仔细看看这个装饰器的源代码:【备注:里面的学号是从原文就有的,表示的应该是行号,与代码内容无关】

def total_ordering(cls):
54 """Class decorator that fills in missing ordering methods"""
55 convert = {
56 '__lt__': [('__gt__', lambda self, other: other < self),
57 ('__le__', lambda self, other: not other < self),
58 ('__ge__', lambda self, other: not self < other)],
59 '__le__': [('__ge__', lambda self, other: other <= self),
60 ('__lt__', lambda self, other: not other <= self),
61 ('__gt__', lambda self, other: not self <= other)],
62 '__gt__': [('__lt__', lambda self, other: other > self),
63 ('__ge__', lambda self, other: not other > self),
64 ('__le__', lambda self, other: not self > other)],
65 '__ge__': [('__le__', lambda self, other: other >= self),
66 ('__gt__', lambda self, other: not other >= self),
67 ('__lt__', lambda self, other: not self >= other)]
68 }
69 roots = set(dir(cls)) & set(convert)
70 if not roots:
71 raise ValueError('must define at least one ordering operation: < > <= >=')
72 root = max(roots) # prefer __lt__ to __le__ to __gt__ to __ge__
73 for opname, opfunc in convert[root]:
74 if opname not in roots:
75 opfunc.__name__ = opname
76 opfunc.__doc__ = getattr(int, opname).__doc__
77 setattr(cls, opname, opfunc)
78 return cls

【写在最后】

  本博客主要是参考原博主的内容,前面的1、2节加了自己的理解进行了整理,后面的第3节觉得写得还不错就拿过来了,代码没有进行验证,如有侵权,联系删帖。更多装饰器的内容点击标签“装饰器”进行了解。

  PS:学会了做超链接,原来右键就可以实现,开森^_^

博主尊重原创,也支持原创,如有侵权,联系博主删帖,转帖请注明出处!

浅尝装饰器和AOP的相关教程结束。

《浅尝装饰器和AOP.doc》

下载本文的Word格式文档,以方便收藏与打印。