Python編程（四）：兩個實用的Python的裝飾器

本文由auxten授權發佈。
商業轉載請聯繫作者獲得授權，非商業轉載請註明出處。
作者：auxten
鏈接：http://zhuanlan.zhihu.com/auxten/20175869

超時函數

這個函數的作用在於可以給任意可能會hang住的函數添加超時功能，這個功能在編寫外部API調用 、網絡爬蟲、數據庫查詢的時候特別有用。

timeout裝飾器的代碼如下：

import signal,functools #下面會用到的兩個庫 
class TimeoutError(Exception): pass #定義一個Exception，後面超時拋出 

def timeout(seconds, error_message = 'Function call timed out'):
  def decorated(func):
    def _handle_timeout(signum, frame):
      raise TimeoutError(error_message)
    def wrapper(*args, **kwargs):
      signal.signal(signal.SIGALRM, _handle_timeout)
      signal.alarm(seconds)
      try:
        result = func(*args, **kwargs)
      finally:
        signal.alarm(0)
      return result
    return functools.wraps(func)(wrapper)
  return decorated

使用：

@timeout(5) #限定下面的slowfunc函數如果在5s內不返回就強制拋TimeoutError Exception結束 
def slowfunc(sleep_time):
  import time
  time.sleep(sleep_time) #這個函數就是休眠sleep_time秒 

slowfunc(3) #sleep 3秒，正常返回 沒有異常 


slowfunc(10) #被終止 

## 輸出 
---------------------------------------------------------------------------
TimeoutError                              Traceback (most recent call last)

Trace函數

有時候出於演示目的或者調試目的，我們需要程序運行的時候打印出每一步的運行順序 和調用邏輯。類似寫bash的時候的bash -x調試功能，然後Python解釋器並沒有 內置這個時分有用的功能，那麼我們就“自己動手，豐衣足食”。

Trace裝飾器的代碼如下：

import sys,os,linecache
def trace(f):
  def globaltrace(frame, why, arg):
    if why == "call": return localtrace
    return None
  def localtrace(frame, why, arg):
    if why == "line":
      # record the file name and line number of every trace 
      filename = frame.f_code.co_filename
      lineno = frame.f_lineno
      bname = os.path.basename(filename)
      print "{}({}): {}".format(  bname,
        lineno,
        linecache.getline(filename, lineno).strip('\r\n')),
    return localtrace
  def _f(*args, **kwds):
    sys.settrace(globaltrace)
    result = f(*args, **kwds)
    sys.settrace(None)
    return result
  return _f

使用：

@trace
def xxx():
  print 1
  print 22
  print 333

xxx() #調用 

## 輸出 
<ipython-input-4-da50741ac84e>(3):     print 1 # @trace 的輸出 
1
<ipython-input-4-da50741ac84e>(4):     print 22 # @trace 的輸出 
22
<ipython-input-4-da50741ac84e>(5):     print 333 # @trace 的輸出 
333