Python 装饰器装饰类中的方法
hushsky
8年前
<p>title: Python 装饰器装饰类中的方法</p> <p>comments: true</p> <p>date: 2017-04-17 20:44:31</p> <p>tags: ['Python', 'Decorate']</p> <p>category: ['Python']</p> <p>---</p> <p>目前在中文网上能搜索到的绝大部分关于装饰器的教程,都在讲如何装饰一个普通的函数。本文介绍如何使用Python的装饰器装饰一个类的方法,同时在装饰器函数中调用类里面的其他方法。本文以捕获一个方法的异常为例来进行说明。</p> <p>有一个类Test, 它的结构如下:</p> <pre> <code class="language-python">class Test(object): def __init__(self): pass def revive(self): print('revive from exception.') # do something to restore def read_value(self): print('here I will do something.') # do something.</code></pre> <p>在类中有一个方法 read_value() ,这个方法在多个地方被调用。由于某些原因,方法 read_value 有可能随机抛出Exception导致程序崩溃。所以需要对整个方法做 try ... except 处理。最丑陋的做法如下面的代码所示:</p> <pre> <code class="language-python">class Test(object): def __init__(self): pass def revive(self): print('revive from exception.') # do something to restore def read_value(self): try: print('here I will do something.') # do something. except Exception as e: print(f'exception {e} raised, parse exception.') # do other thing. self.revive()</code></pre> <p>这样写虽然可以解决问题,但是代码不Pythonic。</p> <p>使用装饰器来解决这个问题,装饰器函数应该写在类里面还是类外面呢?答案是,写在类外面。那么既然写在类外面,如何调用这个类的其他方法呢?</p> <p>首先写出一个最常见的处理异常的装饰器:</p> <pre> <code class="language-python">def catch_exception(origin_func): def wrapper(*args, **kwargs): try: u = origin_func(*args, **kwargs) return u except Exception: return 'an Exception raised.' return wrapper class Test(object): def __init__(self): pass def revive(self): print('revive from exception.') # do something to restore @catch_exception def read_value(self): print('here I will do something.') # do something.</code></pre> <p>这种写法,确实可以捕获到 origin_func() 的异常,但是如果在发生异常的时候,需要调用类里面的另一个方法来处理异常,这又应该怎么办?答案是给wrapper增加一个参数:self.</p> <p>代码变为如下形式:</p> <pre> <code class="language-python">def catch_exception(origin_func): def wrapper(self, *args, **kwargs): try: u = origin_func(self, *args, **kwargs) return u except Exception: self.revive() #不用顾虑,直接调用原来的类的方法 return 'an Exception raised.' return wrapper class Test(object): def __init__(self): pass def revive(self): print('revive from exception.') # do something to restore @catch_exception def read_value(self): print('here I will do something.') # do something.</code></pre> <p>只需要修改装饰器 <strong>定义</strong> 的部分,使用装饰器的地方完全不需要做修改。</p> <p>下图为正常运行时的运行结果:</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/fe09402d93f1835b55fa2867d2b380a5.png"></p> <p>下图为发生异常以后捕获并处理异常:</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/3bc22491e92ce7e74ba46eb25f2b44c9.png"></p> <p>通过添加一个self参数,类外面的装饰器就可以直接使用类里面的各种方法,也可以直接使用类的属性。</p> <p> </p> <p>来自:http://www.cnblogs.com/xieqiankun/p/python_decorate_method.html</p> <p> </p>