Python已存在对象中如何添加额外功能

在Python项目开发(http://www.maiziedu.com/course/python/)时会用到很多场景,比如插入日志、性能测试、事物处理等等,在这时就会用到Python装饰器,Python装饰器是专门解决这列设计问题的。那今天就用演示的方法讲讲Python装饰。

1. 装饰器入门

1.1. 需求是怎么来的?

装饰器的定义很是抽象,我们来看一个小例子。

def foo():

print ‘in foo()‘

foo()

这是一个很无聊的函数没错。但是突然有一个更无聊的人,我们称呼他为B君,说我想看看执行这个函数用了多长时间,好吧,那么我们可以这样做:

import time

def foo():

start = time.clock()

print ‘in foo()‘

end = time.clock()

print ‘used:‘, end - start

foo()

很好,功能看起来无懈可击。可是蛋疼的B君此刻突然不想看这个函数了,他对另一个叫foo2的函数产生了更浓厚的兴趣。

怎么办呢?如果把以上新增加的代码复制到foo2里,这就犯了大忌了~复制什么的难道不是最讨厌了么!而且,如果B君继续看了其他的函数呢?

1.2. 以不变应万变,是变也

还记得吗,函数在Python中是一等公民,那么我们可以考虑重新定义一个函数timeit,将foo的引用传递给他,然后在timeit中调用foo并进行计时,这样,我们就达到了不改动foo定义的目的,而且,不论B君看了多少个函数,我们都不用去修改函数定义了!

import time

def foo():

print ‘in foo()‘

def timeit(func):

start = time.clock()

func()

end =time.clock()

print ‘used:‘, end - start

timeit(foo)

看起来逻辑上并没有问题,一切都很美好并且运作正常!……等等,我们似乎修改了调用部分的代码。原本我们是这样调用的:foo(),修改以后变成 了:timeit(foo)。这样的话,如果foo在N处都被调用了,你就不得不去修改这N处的代码。或者更极端的,考虑其中某处调用的代码无法修改这个 情况,比如:这个函数是你交给别人使用的。

1.3. 最大限度地少改动!

既然如此,我们就来想想办法不修改调用的代码;如果不修改调用代码,也就意味着调用foo()需要产生调用timeit(foo)的效果。我们可以 想到将timeit赋值给foo,但是timeit似乎带有一个参数……想办法把参数统一吧!如果timeit(foo)不是直接产生调用效果,而是返回 一个与foo参数列表一致的函数的话……就很好办了,将timeit(foo)的返回值赋值给foo,然后,调用foo()的代码完全不用修改!

#-*- coding: UTF-8 -*-

import time

def foo():

print ‘in foo()‘

# 定义一个计时器,传入一个,并返回另一个附加了计时功能的方法

def timeit(func):

# 定义一个内嵌的包装函数,给传入的函数加上计时功能的包装

def wrapper():

start = time.clock()

func()

end =time.clock()

print ‘used:‘, end - start

# 将包装后的函数返回

return wrapper

foo = timeit(foo)

foo()

这样,一个简易的计时器就做好了!我们只需要在定义foo以后调用foo之前,加上foo = timeit(foo),就可以达到计时的目的,这也就是装饰器的概念,看起来像是foo被timeit装饰了。在在这个例子中,函数进入和退出时需要计 时,这被称为一个横切面(Aspect),这种编程方式被称为面向切面的编程(Aspect-Oriented Programming)。与传统编程习惯的从上往下执行方式相比较而言,像是在函数执行的流程中横向地插入了一段逻辑。在特定的业务领域里,能减少大量 重复代码。面向切面编程还有相当多的术语,这里就不多做介绍,感兴趣的话可以去找找相关的资料。

这个例子仅用于演示,并没有考虑foo带有参数和有返回值的情况,完善它的重任就交给你了 :)

2. Python的额外支持

2.1. 语法糖

上面这段代码看起来似乎已经不能再精简了,Python于是提供了一个语法糖来降低字符输入量。

import time

def timeit(func):

def wrapper():

start = time.clock()

func()

end =time.clock()

print ‘used:‘, end - start

return wrapper

@timeit

def foo():

print ‘in foo()‘

foo()

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

2.2. 内置的装饰器

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

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

2.3. functools模块

functools模块提供了两个装饰器。这个模块是Python 2.5后新增的,一般来说大家用的应该都高于这个版本。但我平时的工作环境是2.4 T-T

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

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

import time

import functools

def timeit(func):

@functools.wraps(func)

def wrapper():

start = time.clock()

func()

end =time.clock()

print ‘used:‘, end - start

return wrapper

@timeit

def foo():

print ‘in foo()‘

foo()

print foo.__name__

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

2.3.2. total_ordering(cls):

这个装饰器在特定的场合有一定用处,但是它是在Python 2.7后新增的。它的作用是为实现了至少__lt__、__le__、__gt__、__ge__其中一个的类加上其他的比较方法,这是一个类装饰器。如果觉得不好理解,不妨仔细看看这个装饰器的源代码:

def total_ordering(cls):

"""Class decorator that fills in missing ordering methods"""

convert = {

‘__lt__‘: [(‘__gt__‘, lambda self, other: other < self),

(‘__le__‘, lambda self, other: not other < self),

(‘__ge__‘, lambda self, other: not self < other)],

‘__le__‘: [(‘__ge__‘, lambda self, other: other <= self),

(‘__lt__‘, lambda self, other: not other <= self),

(‘__gt__‘, lambda self, other: not self <= other)],

‘__gt__‘: [(‘__lt__‘, lambda self, other: other > self),

(‘__ge__‘, lambda self, other: not other > self),

(‘__le__‘, lambda self, other: not self > other)],

‘__ge__‘: [(‘__le__‘, lambda self, other: other >= self),

(‘__gt__‘, lambda self, other: not other >= self),

}

roots = set(dir(cls)) & set(convert)

if not roots:

raise ValueError(‘must define at least one ordering operation: < > <= >=‘)

root = max(roots)       # prefer __lt__ to __le__ to __gt__ to __ge__

for opname, opfunc in convert[root]:

if opname not in roots:

opfunc.__name__ = opname

opfunc.__doc__ = getattr(int, opname).__doc__

setattr(cls, opname, opfunc)

return cls

本文到这里就全部结束了,看了全部内容之后是不是对Python装饰器有了一定的了解啊,有空的话我会整理一份Python基础教程(http://www.maiziedu.com/course/python/)知识的大纲出来,这样更加利于学习Python。

时间: 2024-10-29 14:23:47

Python已存在对象中如何添加额外功能的相关文章

Python可迭代对象中的添加和删除(add,append,pop,remove,insert)

list: classmates = ['Michael', 'Bob', 'Tracy'] classmates.append('Adam') //添加在末尾,没有add()方法 classmates.insert(1, 'Jack') //在指定位置添加 classmates.pop(1) //在知道位置删除,参数是索引 del classmate[1] //删除第二个元素 classmates.remove('Bob') //参数是元素,删除第一个与Bob值匹配的元素,之后又相同元素不会删

Python学习笔记__4.4章 装饰器(添加额外功能)

# 这是学习廖雪峰老师python教程的学习笔记 1.概览 装饰器可以帮助我们为已经存在的对象添加额外的功能 装饰器本质上是一个Python函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外功能,装饰器的返回值也是一个函数对象. 装饰器经常用于有切面需求的场景,比如:插入日志.性能测试.事物处理.缓存.权限校验等场景. 1.1.为now函数 加一行日志 # 定义now函数 def now(): print('2018-5-8') # 编辑decorator def log(func):

将Hibernate Search集成进已有项目中,实现全文检索功能

本来是准备使用Lucene的但是新版本的API过于繁琐,最后还是决定使用Hibernate Search来实现全文检索.这篇博文以我以前做的博客为例来实现全文检索. 1.修改Hibernate配置文件,因为我的系统采用的是SSH2来开发的所以我修改的是spring配置文件 <bean id="sessionFactory" class="org.springframework.orm.hibernate4.LocalSessionFactoryBean">

Liferay 6.2 改造系列之三:删除Docbar中的添加内容功能

在/portal-master/portal-web/docroot/html/portlet/dockbar/add_panel.jsp文件中 将以下内容: if (hasAddContentAndApplicationsPermission) { tabs1Names = ArrayUtil.append(tabs1Names, "content,applications"); } if (hasLayoutAddPermission) { tabs1Names = ArrayUt

iOS 给系统的对象添加额外的属性----关联属性

@interface NSObject (Objc) // @property (nonatomic, strong) NSString *name; // 在分类中 给系统的类添加属性, 一搬系统的类不能添加额外的属性 @end #import "NSObject+Objc.h" #import <objc/message.h> @implementation NSObject (Objc) //static NSString *_name; -(void)setName

Python中,添加写入数据到已经存在的Excel的xls文件,即打开excel文件,写入新数据

背景 Python中,想要打开已经存在的excel的xls文件,然后在最后新的一行的数据. 折腾过程 1.找到了参考资料: writing to existing workbook using xlwt 其实是没有直接实现: 打开已有的excel文件,然后在文件最后写入,添加新数据 的函数的. 只不过,可以利用: Working with Excel Files in Python 中的库,组合实现. 2. writing to existing workbook using xlwt 给出了示

python基础19 -------面向对象终结篇(介绍python对象中各种内置命令)

一.isinstance()和issubclass()命令 1.isinstance(对象,类型) 用来判定该对象是不是此类型或者说是该对象是不是此类的对象,返回结果为True和False,如图所示. 注:在python3中类和类型做了统一,都叫做类. 2.issubclass(对象(子类),对象(父类)) 用来判定该对象是不是该父类的子类,返回的结果为True或False,如图所示. 二.反射 1.什么是反射? 反射就相当于程序能检测,访问和修改他本身状态和行为的一种能力,相当于自省. 2.p

Resx 文件无效。未能加载 .RESX 文件中使用的类型 System.Collections.Generic.List`1请确保已在项目中添加了必需的引用。

在C#程序编写过程中,会遇到:Resx 文件无效.未能加载 .RESX 文件中使用的类型 System.Collections.Generic.List1`请确保已在项目中添加了必需的引用. 主要原因很可能是使用了类的可序列化的原因,代码如下: [Serializable] public class TimeLineItem { public string Title; public string Content; public TimeLineItem(string content) { th

JavaScript中对象属性的添加和删除

<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>Insert title here</title> <script type="text/javascript"> /* * 用.为对象添加属性 用关键字delete删除属性 用[]添加属性 和.的不同 r.name==r["name"]; r.