python traceback學習(轉)

標籤：構造   pytho   param   ace   type   title   port   字串   tty   

1. Python中的異常棧跟蹤

之前在做Java的時候，異常對象預設就包含stacktrace相關的資訊，通過異常對象的相關方法printStackTrace()和getStackTrace()等方法就可以取到異常棧資訊，能列印到log輔助調試或者做一些別的事情。但是到了Python，在2.x中，異常對象可以是任何對象，經常看到很多代碼是直接raise一個字串出來，因此就不能像Java那樣方便的擷取異常棧了，因為異常對象和異常棧是分開的。而多數Python語言的書籍上重點在於描述Python中如何構造異常對象和raise try except finally這些的使用，對偵錯工具起關鍵作用的stacktrace往往基本上不怎麼涉及。

python中用於處理異常棧的模組是traceback模組，它提供了print_exception、format_exception等輸出異常棧等常用的工具函數。

def func(a, b):return a / bif __name__ == ‘__main__‘:import sysimport tracebacktry:func(1, 0)except Exception as e:print "print exc"traceback.print_exc(file=sys.stdout)

輸出結果：

print excTraceback (most recent call last):  File "./teststacktrace.py", line 7, in <module>    func(1, 0)  File "./teststacktrace.py", line 2, in func    return a / b

其實traceback.print_exc()函數只是traceback.print_exception()函數的一個簡寫形式，而它們擷取異常相關的資料都是通過sys.exc_info()函數得到的。

def func(a, b):return a / bif __name__ == ‘__main__‘:import sysimport tracebacktry:func(1, 0)except Exception as e:print "print_exception()"exc_type, exc_value, exc_tb = sys.exc_info()print ‘the exc type is:‘, exc_typeprint ‘the exc value is:‘, exc_valueprint ‘the exc tb is:‘, exc_tbtraceback.print_exception(exc_type, exc_value, exc_tb)

輸出結果：

print_exception()the exc type is: <type ‘exceptions.ZeroDivisionError‘>the exc value is: integer division or modulo by zerothe exc tb is: <traceback object at 0x104e7d4d0>Traceback (most recent call last):  File "./teststacktrace.py", line 7, in <module>    func(1, 0)  File "./teststacktrace.py", line 2, in func    return a / bZeroDivisionError: integer division or modulo by zero

sys.exc_info()返回的值是一個元組，其中第一個元素，exc_type是異常的物件類型，exc_value是異常的值，exc_tb是一個traceback對象，對象中包含出錯的行數、位置等資料。然後通過print_exception函數對這些異常資料進行整理輸出。

traceback模組提供了extract_tb函數來更加詳細的解釋traceback對象所包含的資料：

def func(a, b):return a / bif __name__ == ‘__main__‘:import sysimport tracebacktry:func(1, 0)except:_, _, exc_tb = sys.exc_info()for filename, linenum, funcname, source in traceback.extract_tb(exc_tb):print "%-23s:%s ‘%s‘ in %s()" % (filename, linenum, source, funcname)

輸出結果：

samchimac:tracebacktest samchi$ python ./teststacktrace.py ./teststacktrace.py    :7 ‘func(1, 0)‘ in <module>()./teststacktrace.py    :2 ‘return a / b‘ in func()

2. 使用cgitb來簡化異常調試

如果平時開發喜歡基於log的方式來調試，那麼可能經常去做這樣的事情，在log裡面發現異常之後，因為資訊不足，那麼會再去額外加一些debug log來把相關變數的值輸出。調試完畢之後再把這些debug log去掉。其實沒必要這麼麻煩，Python庫中提供了cgitb模組來協助做這些事情，它能夠輸出異常上下文所有相關變數的資訊，不必每次自己再去手動加debug log。

cgitb的使用簡單的不能想象：

def func(a, b):        return a / bif __name__ == ‘__main__‘:        import cgitb        cgitb.enable(format=‘text‘)        import sys        import traceback        func(1, 0)

運行之後就會得到詳細的資料:

A problem occurred in a Python script.  Here is the sequence offunction calls leading up to the error, in the order they occurred. /Users/samchi/Documents/workspace/tracebacktest/teststacktrace.py in <module>()    4 import cgitb    5 cgitb.enable(format=‘text‘)    6 import sys    7 import traceback    8 func(1, 0)func = <function func> /Users/samchi/Documents/workspace/tracebacktest/teststacktrace.py in func(a=1, b=0)    2 return a / b    3 if __name__ == ‘__main__‘:    4 import cgitb    5 cgitb.enable(format=‘text‘)    6 import sysa = 1b = 0

完全不必再去log.debug("a=%d" % a)了，個人感覺cgitb線上上環境不適合使用，適合在開發的過程中進行調試，非常的方便。

也許你會問，cgitb為什麼會這麼屌？能擷取這麼詳細的出錯資訊？其實它的工作原理同它的使用方式一樣的簡單，它只是覆蓋了預設的sys.excepthook函數，sys.excepthook是一個預設的全域異常攔截器，可以嘗試去自行對它修改：

def func(a, b):        return a / bdef my_exception_handler(exc_type, exc_value, exc_tb):        print "i caught the exception:", exc_type        while exc_tb:                print "the line no:", exc_tb.tb_lineno                print "the frame locals:", exc_tb.tb_frame.f_locals                exc_tb = exc_tb.tb_nextif __name__ == ‘__main__‘:        import sys        sys.excepthook = my_exception_handler        import traceback        func(1, 0)

輸出結果：

i caught the exception: <type ‘exceptions.ZeroDivisionError‘>the line no: 14the frame locals: {‘my_exception_handler‘: <function my_exception_handler at 0x100e04aa0>, ‘__builtins__‘: <module ‘__builtin__‘ (built-in)>, ‘__file__‘: ‘./teststacktrace.py‘, ‘traceback‘: <module ‘traceback‘ from ‘/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/traceback.pyc‘>, ‘__package__‘: None, ‘sys‘: <module ‘sys‘ (built-in)>, ‘func‘: <function func at 0x100e04320>, ‘__name__‘: ‘__main__‘, ‘__doc__‘: None}the line no: 2the frame locals: {‘a‘: 1, ‘b‘: 0}

看到沒有？沒有什麼神奇的東西，只是從stack frame對象中擷取的相關變數的值。frame對象中還有很多神奇的屬性，就不一一探索了。

3. 使用logging模組來記錄異常

在使用Java的時候，用log4j記錄異常很簡單，只要把Exception對象傳遞給log.error方法就可以了，但是在Python中就不行了，如果直接傳遞異常對象給log.error，那麼只會在log裡面出現一行異常對象的值。

在Python中正確的記錄Log方式應該是這樣的：

logging.exception(ex)logging.error(ex, exc_info=1) # 指名輸出棧蹤跡, logging.exception的內部也是包了一層此做法logging.critical(ex, exc_info=1) # 更加嚴重的錯誤層級
轉自http://www.tuicool.com/articles/f2uumm

traceback.print_exc()跟traceback.format_exc()有什麼區別呢？format_exc()返回字串，print_exc()則直接給列印出來。即traceback.print_exc()與print traceback.format_exc()效果是一樣的。print_exc()還可以接受file參數直接寫入到一個檔案。比如traceback.print_exc(file=open(‘tb.txt‘,‘w+‘))寫入到tb.txt檔案去。

python traceback學習(轉)