快捷導(dǎo)航

淺談Python traceback的優(yōu)雅處理

更新時(shí)間：2018年08月31日 10:51:41 作者：sunsky303

這篇文章主要介紹了淺談Python traceback的優(yōu)雅處理，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

剛接觸Python的時(shí)候，簡(jiǎn)單的異常處理已經(jīng)可以幫助我們解決大多數(shù)問(wèn)題，但是隨著逐漸地深入，我們會(huì)發(fā)現(xiàn)有很多情況下簡(jiǎn)單的異常處理已經(jīng)無(wú)法解決問(wèn)題了，如下代碼，單純的打印異常所能提供的信息會(huì)非常有限。

def func1():
  raise Exception("--func1 exception--")


def main():
  try:
    func1()
  except Exception as e:
    print e


if __name__ == '__main__':
  main()

執(zhí)行后輸出如下：

--func1 exception--

通過(guò)示例，我們發(fā)現(xiàn)普通的打印異常只有很少量的信息（通常是異常的value值），這種情況下我們很難定位在哪塊代碼出的問(wèn)題，以及如何出現(xiàn)這種異常。那么到底要如何打印更加詳細(xì)的信息呢？下面我們就來(lái)一一介紹。

sys.exc_info和traceback object

Python程序的traceback信息均來(lái)源于一個(gè)叫做traceback object的對(duì)象，而這個(gè)traceback object通常是通過(guò)函數(shù)sys.exc_info()來(lái)獲取的，先來(lái)看一個(gè)例子：

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()

執(zhí)行后輸出如下：

exc_type: <type 'exceptions.NameError'>
exc_value: --func1 exception--
exc_traceback_obj: <traceback object at 0x7faddf5d93b0>

通過(guò)以上示例我們可以看出，sys.exc_info()獲取了當(dāng)前處理的exception的相關(guān)信息，并返回一個(gè)元組，元組的第一個(gè)數(shù)據(jù)是異常的類(lèi)型(示例是NameError類(lèi)型)，第二個(gè)返回值是異常的value值，第三個(gè)就是我們要的traceback object.

有了traceback object我們就可以通過(guò)traceback module來(lái)打印和格式化traceback的相關(guān)信息，下面我們就來(lái)看下traceback module的相關(guān)函數(shù)。

traceback module

Python的traceback module提供一整套接口用于提取，格式化和打印Python程序的stack traces信息，下面我們通過(guò)例子來(lái)詳細(xì)了解下這些接口：

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--")

這里我們可以發(fā)現(xiàn)打印的異常信息更加詳細(xì)了，下面我們了解下print_tb的詳細(xì)信息：

traceback.print_tb(tb[, limit[, file]])

tb: 這個(gè)就是traceback object, 是我們通過(guò)sys.exc_info獲取到的
limit: 這個(gè)是限制stack trace層級(jí)的，如果不設(shè)或者為None，就會(huì)打印所有層級(jí)的stack trace
file: 這個(gè)是設(shè)置打印的輸出流的，可以為文件，也可以是stdout之類(lèi)的file-like object。如果不設(shè)或?yàn)镹one，則輸出到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相比多了兩個(gè)參數(shù)etype和value，分別是exception type和exception value，加上tb(traceback object)，正好是sys.exc_info()返回的三個(gè)值
另外，與print_tb相比，打印信息多了開(kāi)頭的"Traceback (most...)"信息以及最后一行的異常類(lèi)型和value信息
還有一個(gè)不同是當(dāng)異常為SyntaxError時(shí)，會(huì)有"^"來(lái)指示語(yǔ)法錯(cuò)誤的位置

print_exc

print_exc是簡(jiǎn)化版的print_exception, 由于exception type, value和traceback object都可以通過(guò)sys.exc_info()獲取，因此print_exc()就自動(dòng)執(zhí)行exc_info()來(lái)幫助獲取這三個(gè)參數(shù)了，也因此這個(gè)函數(shù)是我們的程序中最常用的，因?yàn)樗銐蚝?jiǎn)單

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，因此只有一個(gè)層級(jí)被打印出來(lái)）：

Traceback (most recent call last):
File "<ipython-input-25-a1f5c73b97c4>", line 13, in main
func2()
NameError: --func1 exception--

定義如下：traceback.print_exc([limit[, file]])

只有兩個(gè)參數(shù)，夠簡(jiǎn)單

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()

從這個(gè)例子可以看出有時(shí)候我們想得到的是一個(gè)字符串，比如我們想通過(guò)logger將異常記錄在log里，這個(gè)時(shí)候就需要format_exc了，這個(gè)也是最常用的一個(gè)函數(shù)，它跟print_exc用法相同，只是不直接打印而是返回了字符串。

traceback module中還有一些其它的函數(shù)，但因?yàn)椴⒉怀Ｓ?，就不在展開(kāi)來(lái)講，感興趣的同學(xué)可以看下參考鏈接中的文檔。

獲取線程中的異常信息

通常情況下我們無(wú)法將多線程中的異常帶回主線程，所以也就無(wú)法打印線程中的異常，而通過(guò)上邊學(xué)到這些知識(shí)，我們可以對(duì)線程做如下修改，從而實(shí)現(xiàn)捕獲線程異常的目的。

以下示例來(lái)自weidong的博客文章，稍有修改（見(jiàn)參考鏈接）

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

這樣我們就得到了線程中的異常信息。

參考鏈接

traceback官方文檔 https://docs.python.org/2/library/traceback.html

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: