例外の説明と、例外を引き起こしたスタックトレースをすべて文字列として取得します。

423

Pythonのスタックトレースと例外に関する多くの投稿を見てきました。しかし、必要なものが見つかりませんでした。

例外が発生する可能性のあるPython 2.7コードのチャンクがあります。私はそれをキャッチして、エラーの原因となった完全な説明とスタックトレースを文字列に割り当てたいと思っています（単にコンソールで確認するために使用しているすべてのものです）。GUIのテキストボックスに印刷するには、この文字列が必要です。

このようなもの：

try:
    method_that_can_raise_an_exception(params)
except Exception as e:
    print_to_textbox(complete_exception_description(e))

問題は次のとおりです：関数は何complete_exception_descriptionですか？

— 青みがかった
ソース

615

tracebackモジュール、特にformat_exc()関数を参照してください。こちら。

import traceback

try:
    raise ValueError
except ValueError:
    tb = traceback.format_exc()
else:
    tb = "No error"
finally:
    print tb

— ちょっと
ソース

2

これは最後のエラーでのみ機能しますか？エラーをコードの他のビットに渡し始めたらどうなりますか？log_error(err)関数を書いています。

— AnnanFay

キャッチして処理したエラーで動作します。

— キンドール

74

完全なスタックトレースを取得できることを示すために、かなり複雑なスタックトレースを作成してみましょう。

def raise_error():
    raise RuntimeError('something bad happened!')

def do_something_that_might_error():
    raise_error()

完全なスタックトレースのロギング

モジュールにロガーを設定することをお勧めします。モジュールの名前を認識し、（ハンドラーなどの他の属性の中でも）レベルを変更できる

import logging
logging.basicConfig(level=logging.DEBUG)
logger = logging.getLogger(__name__)

そして、このロガーを使用してエラーを取得できます：

try:
    do_something_that_might_error()
except Exception as error:
    logger.exception(error)

どのログ：

ERROR:__main__:something bad happened!
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
  File "<stdin>", line 2, in do_something_that_might_error
  File "<stdin>", line 2, in raise_error
RuntimeError: something bad happened!

したがって、エラーが発生した場合と同じ出力が得られます。

>>> do_something_that_might_error()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 2, in do_something_that_might_error
  File "<stdin>", line 2, in raise_error
RuntimeError: something bad happened!

文字列だけを取得する

本当に文字列が必要な場合は、traceback.format_exc代わりに関数を使用して、ここで文字列のロギングを示します。

import traceback
try:
    do_something_that_might_error()
except Exception as error:
    just_the_string = traceback.format_exc()
    logger.debug(just_the_string)

どのログ：

DEBUG:__main__:Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
  File "<stdin>", line 2, in do_something_that_might_error
  File "<stdin>", line 2, in raise_error
RuntimeError: something bad happened!

— アーロンホール
ソース

1

これはpython 3を使用する場合の最良の方法ですか（たとえば、以下の回答のいくつかと比較して）？

— ユンティ

1

@Yunti私は、このAPIは、Python 2と3の間で一貫してきたと信じて

— アーロン・ホール

この回答のフォーマットについてはmeta：stackoverflow.com/questions/386477/…で議論されました。

— ランディン

私は次のように編集を送ったが、匿名として示すように記録されていなかった： except Exception as e: logger.exception("<<clearly and distinctly describe what failed here>>", exc_info=e)

— arntg

@arntgあなたが助けようとしていることを感謝しますが、その編集は有害な変更になります。今後は、使用しようとしているAPIを完全に理解するように、さらに注意してください。この場合、exc_info引数は「例外タプル」を期待してerrorいますが、はExceptionオブジェクト（またはサブクラス）のインスタンスであり、に変更errorする必要はありませんe。

— アーロンホール

39

Python 3では、次のコードは、Exceptionを使用して取得されるとおりにオブジェクトをフォーマットしますtraceback.format_exc()。

import traceback

try: 
    method_that_can_raise_an_exception(params)
except Exception as ex:
    print(''.join(traceback.format_exception(etype=type(ex), value=ex, tb=ex.__traceback__)))

利点は、Exceptionオブジェクトのみが必要であること（記録された__traceback__属性のおかげ）であり、したがって、さらなる処理のために別の関数に引数としてより簡単に渡すことができるということです。

— アーウィンメイヤー
ソース

1

これは、オブジェクト指向スタイルではなく、グローバル変数を使用するsys.exc_info（）よりも優れています。

— WeiChing林煒清

これは、ここで行ったように例外オブジェクトからトレースバックを取得する方法を具体的に尋ねる：stackoverflow.com/questions/11414894/...

— チロSantilli郝海东冠状病六四事件法轮功

そこシンプルなのpython3の方法は使用せずにある.__traceback__とtype、参照stackoverflow.com/a/58764987/5717886

— don_vanchos

34

>>> import sys
>>> import traceback
>>> try:
...   5 / 0
... except ZeroDivisionError as e:
...   type_, value_, traceback_ = sys.exc_info()
>>> traceback.format_tb(traceback_)
['  File "<stdin>", line 2, in <module>\n']
>>> value_
ZeroDivisionError('integer division or modulo by zero',)
>>> type_
<type 'exceptions.ZeroDivisionError'>
>>>
>>> 5 / 0
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ZeroDivisionError: integer division or modulo by zero

sys.exc_info（）を使用して、tracebackモジュール内の情報と関数を収集し、それをフォーマットします。ここではそれをフォーマットするためのいくつかの例があります。

例外文字列全体は次の場所にあります。

>>> ex = traceback.format_exception(type_, value_, traceback_)
>>> ex
['Traceback (most recent call last):\n', '  File "<stdin>", line 2, in <module>\n', 'ZeroDivisionError: integer division or modulo by zero\n']

— エイター
ソース

9

Python-3を使用している方

tracebackモジュールを使用するとexception.__traceback__、次のようにスタックトレースを抽出できます。

を使用して現在のスタックトレースを取得しますtraceback.extract_stack()
最後の3つの要素を削除します（これらはスタック内のエントリで、デバッグ関数に移動します）
を使用__traceback__して例外オブジェクトからを追加しますtraceback.extract_tb()
使用して全体をフォーマットする traceback.format_list()

import traceback
def exception_to_string(excp):
   stack = traceback.extract_stack()[:-3] + traceback.extract_tb(excp.__traceback__)  # add limit=?? 
   pretty = traceback.format_list(stack)
   return ''.join(pretty) + '\n  {} {}'.format(excp.__class__,excp)

簡単なデモ：

def foo():
    try:
        something_invalid()
    except Exception as e:
        print(exception_to_string(e))

def bar():
    return foo()

を呼び出すと、次の出力が得られますbar()。

  File "./test.py", line 57, in <module>
    bar()
  File "./test.py", line 55, in bar
    return foo()
  File "./test.py", line 50, in foo
    something_invalid()

  <class 'NameError'> name 'something_invalid' is not defined

— マイクN
ソース

読めない複雑なコードのように見えます。Python 3.5+よりエレガントでシンプルな方法があります：stackoverflow.com/a/58764987/5717886

— don_vanchos

6

また、組み込みのPythonモジュールcgitbを使用して、ローカル変数値、ソースコードコンテキスト、関数パラメーターなど、いくつかの本当に良い、適切にフォーマットされた例外情報を取得することも検討してください。

たとえば、このコードの場合...

import cgitb
cgitb.enable(format='text')

def func2(a, divisor):
    return a / divisor

def func1(a, b):
    c = b - 5
    return func2(a, c)

func1(1, 5)

この例外出力を取得します...

ZeroDivisionError
Python 3.4.2: C:\tools\python\python.exe
Tue Sep 22 15:29:33 2015

A problem occurred in a Python script.  Here is the sequence of
function calls leading up to the error, in the order they occurred.

 c:\TEMP\cgittest2.py in <module>()
    7 def func1(a, b):
    8   c = b - 5
    9   return func2(a, c)
   10
   11 func1(1, 5)
func1 = <function func1>

 c:\TEMP\cgittest2.py in func1(a=1, b=5)
    7 def func1(a, b):
    8   c = b - 5
    9   return func2(a, c)
   10
   11 func1(1, 5)
global func2 = <function func2>
a = 1
c = 0

 c:\TEMP\cgittest2.py in func2(a=1, divisor=0)
    3
    4 def func2(a, divisor):
    5   return a / divisor
    6
    7 def func1(a, b):
a = 1
divisor = 0
ZeroDivisionError: division by zero
    __cause__ = None
    __class__ = <class 'ZeroDivisionError'>
    __context__ = None
    __delattr__ = <method-wrapper '__delattr__' of ZeroDivisionError object>
    __dict__ = {}
    __dir__ = <built-in method __dir__ of ZeroDivisionError object>
    __doc__ = 'Second argument to a division or modulo operation was zero.'
    __eq__ = <method-wrapper '__eq__' of ZeroDivisionError object>
    __format__ = <built-in method __format__ of ZeroDivisionError object>
    __ge__ = <method-wrapper '__ge__' of ZeroDivisionError object>
    __getattribute__ = <method-wrapper '__getattribute__' of ZeroDivisionError object>
    __gt__ = <method-wrapper '__gt__' of ZeroDivisionError object>
    __hash__ = <method-wrapper '__hash__' of ZeroDivisionError object>
    __init__ = <method-wrapper '__init__' of ZeroDivisionError object>
    __le__ = <method-wrapper '__le__' of ZeroDivisionError object>
    __lt__ = <method-wrapper '__lt__' of ZeroDivisionError object>
    __ne__ = <method-wrapper '__ne__' of ZeroDivisionError object>
    __new__ = <built-in method __new__ of type object>
    __reduce__ = <built-in method __reduce__ of ZeroDivisionError object>
    __reduce_ex__ = <built-in method __reduce_ex__ of ZeroDivisionError object>
    __repr__ = <method-wrapper '__repr__' of ZeroDivisionError object>
    __setattr__ = <method-wrapper '__setattr__' of ZeroDivisionError object>
    __setstate__ = <built-in method __setstate__ of ZeroDivisionError object>
    __sizeof__ = <built-in method __sizeof__ of ZeroDivisionError object>
    __str__ = <method-wrapper '__str__' of ZeroDivisionError object>
    __subclasshook__ = <built-in method __subclasshook__ of type object>
    __suppress_context__ = False
    __traceback__ = <traceback object>
    args = ('division by zero',)
    with_traceback = <built-in method with_traceback of ZeroDivisionError object>

The above is a description of an error in a Python program.  Here is
the original traceback:

Traceback (most recent call last):
  File "cgittest2.py", line 11, in <module>
    func1(1, 5)
  File "cgittest2.py", line 9, in func1
    return func2(a, c)
  File "cgittest2.py", line 5, in func2
    return a / divisor
ZeroDivisionError: division by zero

— サマスピン
ソース

5

例外が処理されないときに提供される同じ情報を取得したい場合は、次のようにすることができます。しimport tracebackてから：

try:
    ...
except Exception as e:
    print(traceback.print_tb(e.__traceback__))

Python 3.7を使用しています。

— サミュエルN
ソース

3

用のPython 3.5+：

したがって、他の例外と同様に、例外からスタックトレースを取得できます。traceback.TracebackExceptionそれのために使用します（exあなたの例外で置き換えるだけです）：

print("".join(traceback.TracebackException.from_exception(ex).format())

これを行うための拡張された例とその他の機能：

import traceback

try:
    1/0
except Exception as ex:
    print("".join(traceback.TracebackException.from_exception(ex).format()) == traceback.format_exc() == "".join(traceback.format_exception(type(ex), ex, ex.__traceback__))) # This is True !!
    print("".join(traceback.TracebackException.from_exception(ex).format()))

出力は次のようになります。

True
Traceback (most recent call last):
  File "untidsfsdfsdftled.py", line 29, in <module>
    1/0
ZeroDivisionError: division by zero

— don_vanchos
ソース

1

私の2セント：

import sys, traceback
try: 
  ...
except Exception, e:
  T, V, TB = sys.exc_info()
  print ''.join(traceback.format_exception(T,V,TB))

— ユーザー1155692
ソース

1

pythonがエラーをスローしたときとまったく同じように例外とスタックトレースメッセージを表示することが目的である場合、次はpython 2 + 3の両方で機能します。

import sys, traceback


def format_stacktrace():
    parts = ["Traceback (most recent call last):\n"]
    parts.extend(traceback.format_stack(limit=25)[:-2])
    parts.extend(traceback.format_exception(*sys.exc_info())[1:])
    return "".join(parts)

# EXAMPLE BELOW...

def a():
    b()


def b():
    c()


def c():
    d()


def d():
    assert False, "Noooh don't do it."


print("THIS IS THE FORMATTED STRING")
print("============================\n")

try:
    a()
except:
    stacktrace = format_stacktrace()
    print(stacktrace)

print("THIS IS HOW PYTHON DOES IT")
print("==========================\n")
a()

format_stacktrace()スタックから最後の呼び出しを削除し、残りを結合することで機能します。上記の例を実行すると、次の出力が得られます。

THIS IS THE FORMATTED STRING
============================

Traceback (most recent call last):
  File "test.py", line 31, in <module>
    a()
  File "test.py", line 12, in a
    b()
  File "test.py", line 16, in b
    c()
  File "test.py", line 20, in c
    d()
  File "test.py", line 24, in d
    assert False, "Noooh don't do it."
AssertionError: Noooh don't do it.

THIS IS HOW PYTHON DOES IT
==========================

Traceback (most recent call last):
  File "test.py", line 38, in <module>
    a()
  File "test.py", line 12, in a
    b()
  File "test.py", line 16, in b
    c()
  File "test.py", line 20, in c
    d()
  File "test.py", line 24, in d
    assert False, "Noooh don't do it."
AssertionError: Noooh don't do it.

— ルーン・カーガード
ソース

0

次のヘルパークラスを定義しました。

import traceback
class TracedExeptions(object):
    def __init__(self):
        pass
    def __enter__(self):
        pass

    def __exit__(self, etype, value, tb):
      if value :
        if not hasattr(value, 'traceString'):
          value.traceString = "\n".join(traceback.format_exception(etype, value, tb))
        return False
      return True

これは後でこのように使用できます：

with TracedExeptions():
  #some-code-which-might-throw-any-exception

そして後でそれをこのように消費することができます：

def log_err(ex):
  if hasattr(ex, 'traceString'):
    print("ERROR:{}".format(ex.traceString));
  else:
    print("ERROR:{}".format(ex));

（背景：Promises をsと一緒に使用するため、私は失望しましたException。残念なことに、ある場所で発生した例外を別の場所のon_rejectedハンドラーに渡すため、元の場所からトレースバックを取得することは困難です。）

— qbolec
ソース