Python Traceback詳解
剛接觸Python的時候，簡單的異常處理已經能夠幫助咱們解決大多數問題，可是隨着逐漸地深刻，咱們會發現有不少狀況下簡單的異常處理已經沒法解決問題了，以下代碼，單純的打印異常所能提供的信息會很是有限。html
def func1(): raise Exception("--func1 exception--") def main(): try: func1() except Exception as e: print e if __name__ == '__main__': main()
執行後輸出以下：python
--func1 exception--
經過示例，咱們發現普通的打印異常只有不多量的信息（一般是異常的value值），這種狀況下咱們很難定位在哪塊代碼出的問題，以及如何出現這種異常。那麼到底要如何打印更加詳細的信息呢？下面咱們就來一一介紹。git
sys.exc_info和traceback object
Python程序的traceback信息均來源於一個叫作traceback object的對象，而這個traceback object一般是經過函數sys.exc_info()來獲取的，先來看一個例子：github
import sys def func1(): raise NameError("--func1 exception--") def main(): try: func1() except Exception as e: exc_type, exc_value, exc_traceback_obj = sys.exc_info() print "exc_type: %s" % exc_type print "exc_value: %s" % exc_value print "exc_traceback_obj: %s" % exc_traceback_obj if __name__ == '__main__': main()
執行後輸出以下：ruby
exc_type: <type 'exceptions.NameError'> exc_value: --func1 exception-- exc_traceback_obj: <traceback object at 0x7faddf5d93b0>
經過以上示例咱們能夠看出，sys.exc_info()獲取了當前處理的exception的相關信息，並返回一個元組，元組的第一個數據是異常的類型(示例是NameError類型)，第二個返回值是異常的value值，第三個就是咱們要的traceback object.bash
有了traceback object咱們就能夠經過traceback module來打印和格式化traceback的相關信息，下面咱們就來看下traceback module的相關函數。多線程
traceback module
Python的traceback module提供一整套接口用於提取，格式化和打印Python程序的stack traces信息，下面咱們經過例子來詳細瞭解下這些接口：函數
print_tb
import sys import traceback def func1(): raise NameError("--func1 exception--") def main(): try: func1() except Exception as e: exc_type, exc_value, exc_traceback_obj = sys.exc_info() traceback.print_tb(exc_traceback_obj) if __name__ == '__main__': main()
輸出：
File "<ipython-input-23-52bdf2c9489c>", line 11, in main func1() File "<ipython-input-23-52bdf2c9489c>", line 6, in func1 raise NameError("--func1 exception--")
這裏咱們能夠發現打印的異常信息更加詳細了，下面咱們瞭解下print_tb的詳細信息：
traceback.print_tb(tb[, limit[, file]])
- tb: 這個就是traceback object, 是咱們經過sys.exc_info獲取到的
- limit: 這個是限制stack trace層級的，若是不設或者爲None，就會打印全部層級的stack trace
- file: 這個是設置打印的輸出流的，能夠爲文件，也能夠是stdout之類的file-like object。若是不設或爲None，則輸出到sys.stderr。
print_exception
import sys import traceback def func1(): raise NameError("--func1 exception--") def func2(): func1() def main(): try: func2() except Exception as e: exc_type, exc_value, exc_traceback_obj = sys.exc_info() traceback.print_exception(exc_type, exc_value, exc_traceback_obj, limit=2, file=sys.stdout) if __name__ == '__main__': main()
輸出：
Traceback (most recent call last):
File "<ipython-input-24-a68061acf52f>", line 13, in main func2() File "<ipython-input-24-a68061acf52f>", line 9, in func2 func1() NameError: --func1 exception--
看下定義：
traceback.print_exception(etype, value, tb[, limit[, file]])
- 跟print_tb相比多了兩個參數etype和value，分別是exception type和exception value，加上tb(traceback object)，正好是sys.exc_info()返回的三個值
- 另外，與print_tb相比，打印信息多了開頭的"Traceback (most...)"信息以及最後一行的異常類型和value信息
- 還有一個不一樣是當異常爲SyntaxError時，會有"^"來指示語法錯誤的位置
print_exc
print_exc是簡化版的print_exception, 因爲exception type, value和traceback object均可以經過sys.exc_info()獲取，所以print_exc()就自動執行exc_info()來幫助獲取這三個參數了，也所以這個函數是咱們的程序中最經常使用的，由於它足夠簡單
import sys import traceback def func1(): raise NameError("--func1 exception--") def func2(): func1() def main(): try: func2() except Exception as e: traceback.print_exc(limit=1, file=sys.stdout) if __name__ == '__main__': main()
輸出（因爲limit=1，所以只有一個層級被打印出來）：
Traceback (most recent call last):
File "<ipython-input-25-a1f5c73b97c4>", line 13, in main func2() NameError: --func1 exception--
定義以下：
traceback.print_exc([limit[, file]])
- 只有兩個參數，夠簡單
format_exc
import logging import sys import traceback logger = logging.getLogger("traceback_test") def func1(): raise NameError("--func1 exception--") def func2(): func1() def main(): try: func2() except Exception as e: logger.error(traceback.format_exc(limit=1, file=sys.stdout)) if __name__ == '__main__': main()
從這個例子能夠看出有時候咱們想獲得的是一個字符串，好比咱們想經過logger將異常記錄在log裏，這個時候就須要format_exc了，這個也是最經常使用的一個函數，它跟print_exc用法相同，只是不直接打印而是返回了字符串。
traceback module中還有一些其它的函數，但由於並不經常使用，就不在展開來說，感興趣的同窗能夠看下參考連接中的文檔。
獲取線程中的異常信息
一般狀況下咱們沒法將多線程中的異常帶回主線程，因此也就沒法打印線程中的異常，而經過上邊學到這些知識，咱們能夠對線程作以下修改，從而實現捕獲線程異常的目的。
如下示例來自weidong的博客文章，稍有修改（見參考連接）
import threading import traceback def my_func(): raise BaseException("thread exception") class ExceptionThread(threading.Thread): def __init__(self, group=None, target=None, name=None, args=(), kwargs=None, verbose=None): """ Redirect exceptions of thread to an exception handler. """ threading.Thread.__init__(self, group, target, name, args, kwargs, verbose) if kwargs is None: kwargs = {} self._target = target self._args = args self._kwargs = kwargs self._exc = None def run(self): try: if self._target: self._target() except BaseException as e: import sys self._exc = sys.exc_info() finally: #Avoid a refcycle if the thread is running a function with #an argument that has a member that points to the thread. del self._target, self._args, self._kwargs def join(self): threading.Thread.join(self) if self._exc: msg = "Thread '%s' threw an exception: %s" % (self.getName(), self._exc[1]) new_exc = Exception(msg) raise new_exc.__class__, new_exc, self._exc[2] t = ExceptionThread(target=my_func, name='my_thread') t.start() try: t.join() except: traceback.print_exc()
輸出以下：
Traceback (most recent call last):
File "/data/code/testcode/thread_exc.py", line 43, in <module> t.join() File "/data/code/testcode/thread_exc.py", line 23, in run self._target() File "/data/code/testcode/thread_exc.py", line 5, in my_func raise BaseException("thread exception") Exception: Thread 'my_thread' threw an exception: thread exception
這樣咱們就獲得了線程中的異常信息。