# 29.9. `traceback` --- スタックトレースの表示または取得

ソースコード: Lib/traceback.py

このモジュールは Python プログラムのスタックトレースを抽出し、書式を整え、表示するための標準インターフェースを提供します。モジュールがスタックトレースを表示するとき、Python インタープリタの動作を正確に模倣します。インタープリタの"ラッパー"の場合のように、プログラムの制御の元でスタックトレースを表示したいと思ったときに役に立ちます。

モジュールはトレースバックオブジェクトを使用します。このオブジェクトの型は `sys.last_traceback` 変数に格納され、`sys.exc_info()` の三番目に返されます。

このモジュールには、以下の関数が定義されています:

`traceback.``print_tb`(tb, limit=None, file=None)

  limit が正の場合、トレースバックオブジェクト tb から limit までのスタックトレース項目 (呼び出し側のフレームから開始) を出力します。 そうでない場合、最新 `abs(limit)` 項目を出力します。 limit が省略されるか `None` の場合、すべての項目が出力されます。 file が省略されるか `None` の場合は、 `sys.stderr` へ出力されます。 そうでない場合、 file は出力を受け取る開いたファイルまたは file-like オブジェクトでなければなりません。

  バージョン 3.5 で変更: 負の limit がサポートされました。

`traceback.``print_exception`(etype, value, tb, limit=None, file=None, chain=True)

  トレースバックオブジェクト tb から例外の情報とスタックトレースの項目を file に出力します。 この関数は以下の点で `print_tb()` と異なります:

  - tb が `None` でない場合ヘッダ `Traceback (most recent call last):` を出力します

  - スタックトレースの後に例外 etype と value を出力します

  - type(value) が `SyntaxError` であり、 value が適切な形式を持っていれば、そのエラーのおおよその位置を示すマークと共にシンタックスエラーが発生した行が表示されます。

  オプション引数 limit の意味は `print_tb()` のものと同じです。 chain が真の場合 (デフォルト)、連鎖した例外 (例外の `__cause__` か `__context__` 属性) も出力されます。 これはインタープリタ自身が処理されていない例外を出力するときと同じです。

  バージョン 3.5 で変更: 引数 etype は無視され、 value の型から推論されます。

`traceback.``print_exc`(limit=None, file=None, chain=True)

  `print_exception(*sys.exc_info(), limit, file, chain)` の省略表現です。

`traceback.``print_last`(limit=None, file=None, chain=True)

  `print_exception(sys.last_type, sys.last_value, sys.last_traceback, limit, file, chain)` の省略表現です。 一般に、例外が対話的なプロンプトに達した後にのみ機能します (`sys.last_type` 参照)。

`traceback.``print_stack`(f=None, limit=None, file=None)

  limit が正の場合、最大 limit 個のスタックトレース項目 (呼び出し地点から開始) を出力します。 そうでない場合、最新の `abs(limit)` 個を出力します。 limit が省略されるか `None` の場合、すべての項目が出力されます。オプションの f 引数は、開始するスタックフレームを指定するために用いることができます。オプションの file 引数は `print_tb()` の file 引数と同様の意味を持っています。

  バージョン 3.5 で変更: 負の limit がサポートされました。

`traceback.``extract_tb`(tb, limit=None)

  Return a `StackSummary` object representing a list of "pre-processed" stack trace entries extracted from the traceback object tb. It is useful for alternate formatting of stack traces. The optional limit argument has the same meaning as for `print_tb()`. A "pre-processed" stack trace entry is a `FrameSummary` object containing attributes `filename`, `lineno`, `name`, and `line` representing the information that is usually printed for a stack trace. The `line` is a string with leading and trailing whitespace stripped; if the source is not available it is `None`.

`traceback.``extract_stack`(f=None, limit=None)

  現在のスタックフレームから生のトレースバックを取り出します。戻り値は `extract_tb()` と同じ形式です。オプションの f と limit 引数は `print_stack()` と同じ意味を持ちます。

`traceback.``format_list`(extracted_list)

  Given a list of tuples or `FrameSummary` objects as returned by `extract_tb()` or `extract_stack()`, return a list of strings ready for printing. Each string in the resulting list corresponds to the item with the same index in the argument list. Each string ends in a newline; the strings may contain internal newlines as well, for those items whose source text line is not `None`.

`traceback.``format_exception_only`(etype, value)

  トレースバックの例外部分を書式化します。引数は `sys.last_type` と `sys.last_value` のような例外の型と値です。戻り値はそれぞれが改行で終わっている文字列のリストです。通常、リストは一つの文字列を含んでいます。しかし、 `SyntaxError` 例外に対しては、 (出力されるときに) 構文エラーが起きた場所についての詳細な情報を示す行をいくつか含んでいます。どの例外が起きたのかを示すメッセージは、常にリストの最後の文字列です。

`traceback.``format_exception`(etype, value, tb, limit=None, chain=True)

  スタックトレースと例外情報を書式化します。引数は `print_exception()` の対応する引数と同じ意味を持ちます。戻り値は文字列のリストで、それぞれの文字列は改行で終わり、そのいくつかは内部に改行を含みます。これらの行が連結されて出力される場合は、厳密に `print_exception()` と同じテキストが出力されます。

  バージョン 3.5 で変更: 引数 etype は無視され、 value の型から推論されます。

`traceback.``format_exc`(limit=None, chain=True)

  これは、`print_exc(limit)` に似ていますが、ファイルに出力する代わりに文字列を返します。

`traceback.``format_tb`(tb, limit=None)

  `format_list(extract_tb(tb, limit))` の省略表現です。

`traceback.``format_stack`(f=None, limit=None)

  `format_list(extract_stack(f, limit))` の省略表現です。

`traceback.``clear_frames`(tb)

  各フレームオブジェクトの `clear()` メソッドを呼んでトレースバック tb 内の全スタックフレームの局所変数を消去します。

  バージョン 3.4 で追加.

`traceback.``walk_stack`(f)

  Walk a stack following `f.f_back` from the given frame, yielding the frame and line number for each frame. If f is `None`, the current stack is used. This helper is used with `StackSummary.extract()`.

  バージョン 3.5 で追加.

`traceback.``walk_tb`(tb)

  Walk a traceback following `tb_next` yielding the frame and line number for each frame. This helper is used with `StackSummary.extract()`.

  バージョン 3.5 で追加.

このモジュールは以下のクラスも定義しています:

## 29.9.1. `TracebackException` オブジェクト

バージョン 3.5 で追加.

`TracebackException` オブジェクトは実際の例外から作られ、後の出力のために軽量な方法でデータをキャプチャします。

class `traceback.``TracebackException`(exc_type, exc_value, exc_traceback, *, limit=None, lookup_lines=True, capture_locals=False)

  後のレンダリングのために例外をキャプチャします。 limit、lookup_lines、capture_locals は `StackSummary` class のものです。

  局所変数がキャプチャされたとき、それらはトレースバックに表示されることに注意してください。

  `__cause__`

    元々の `__cause__` の `TracebackException`。

  `__context__`

    元々の `__context__` の `TracebackException`。

  `__suppress_context__`

    元々の例外からの `__suppress_context__`。

  `stack`

    トレースバックを表す `StackSummary`。

  `exc_type`

    元々のトレースバックのクラス。

  `filename`

    構文エラー用 - エラーが発生したファイルの名前。

  `lineno`

    構文エラー用 - エラーが発生した行番号。

  `text`

    構文エラー用 - エラーが発生したテクスト。

  `offset`

    構文エラー用 - エラーが発生したテクストへのオフセット。

  `msg`

    構文エラー用 - コンパイラのエラーメッセージ。

  classmethod `from_exception`(exc, *, limit=None, lookup_lines=True, capture_locals=False)

    後のレンダリングのために例外をキャプチャします。 limit、lookup_lines、capture_locals は `StackSummary` class のものです。

    局所変数がキャプチャされたとき、それらはトレースバックに表示されることに注意してください。

  `format`(*, chain=True)

    例外を書式化します。

    chain が `True` でない場合 `__cause__` と `__context__` は書式化されません。

    返り値は文字列のジェネレータで、それぞれ改行で終わりますが、内部に改行を持つものもあります。 `print_exception()` はこのメソッドのラッパで、単にファイルに出力します。

    例外発生を指すメッセージは常に出力の最後の文字列です。

  `format_exception_only`()

    トレースバックの例外部を書式化します。

    返り値は文字列のジェネレータで、それぞれ改行で終わります。

    通常、ジェネレータが出す文字列は一つです。 しかしながら `SyntaxError` 例外の場合、構文例外が発生した箇所の詳細な情報を表す行を複数出します。

    例外発生を指すメッセージは常に出力の最後の文字列です。

## 29.9.2. `StackSummary` オブジェクト

バージョン 3.5 で追加.

`StackSummary` オブジェクトは書式化の準備ができているコールスタックを表します。

class `traceback.``StackSummary`
  classmethod `extract`(frame_gen, *, limit=None, lookup_lines=True, capture_locals=False)

    ジェネレータ (例えば `walk_stack()` や `walk_tb()` が返すもの) から `StackSummary` を構築します。

    If limit is supplied, only this many frames are taken from frame_gen. If lookup_lines is `False`, the returned `FrameSummary` objects will not have read their lines in yet, making the cost of creating the `StackSummary` cheaper (which may be valuable if it may not actually get formatted). If capture_locals is `True` the local variables in each `FrameSummary` are captured as object representations.

  classmethod `from_list`(a_list)

    Construct a `StackSummary` object from a supplied list of `FrameSummary` objects or old-style list of tuples. Each tuple should be a 4-tuple with filename, lineno, name, line as the elements.

  `format`()

    Returns a list of strings ready for printing. Each string in the resulting list corresponds to a single frame from the stack. Each string ends in a newline; the strings may contain internal newlines as well, for those items with source text lines.

    For long sequences of the same frame and line, the first few repetitions are shown, followed by a summary line stating the exact number of further repetitions.

    バージョン 3.6 で変更: Long sequences of repeated frames are now abbreviated.

## 29.9.3. `FrameSummary` オブジェクト

バージョン 3.5 で追加.

`FrameSummary` オブジェクトトレースバック内の単一のフレームを表します。

class `traceback.``FrameSummary`(filename, lineno, name, lookup_line=True, locals=None, line=None)

  Represent a single frame in the traceback or stack that is being formatted or printed. It may optionally have a stringified version of the frames locals included in it. If lookup_line is `False`, the source code is not looked up until the `FrameSummary` has the `line` attribute accessed (which also happens when casting it to a tuple). `line` may be directly provided, and will prevent line lookups happening at all. locals is an optional local variable dictionary, and if supplied the variable representations are stored in the summary for later display.

## 29.9.4. トレースバックの例

この簡単な例では基本的な read-eval-print ループを実装しています。標準的な Python の対話インタープリタループに似ていますが、 Python のものより便利ではありません。インタープリタループのより完全な実装については、 `code` モジュールを参照してください。

    import sys, traceback

    def run_user_code(envdir):
        source = input(">>> ")
        try:
            exec(source, envdir)
        except Exception:
            print("Exception in user code:")
            print("-"*60)
            traceback.print_exc(file=sys.stdout)
            print("-"*60)

    envdir = {}
    while True:
        run_user_code(envdir)

次の例は例外とトレースバックの出力並びに形式が異なることを示します:

    import sys, traceback

    def lumberjack():
        bright_side_of_death()

    def bright_side_of_death():
        return tuple()[0]

    try:
        lumberjack()
    except IndexError:
        exc_type, exc_value, exc_traceback = sys.exc_info()
        print("*** print_tb:")
        traceback.print_tb(exc_traceback, limit=1, file=sys.stdout)
        print("*** print_exception:")
        # exc_type below is ignored on 3.5 and later
        traceback.print_exception(exc_type, exc_value, exc_traceback,
                                  limit=2, file=sys.stdout)
        print("*** print_exc:")
        traceback.print_exc(limit=2, file=sys.stdout)
        print("*** format_exc, first and last line:")
        formatted_lines = traceback.format_exc().splitlines()
        print(formatted_lines[0])
        print(formatted_lines[-1])
        print("*** format_exception:")
        # exc_type below is ignored on 3.5 and later
        print(repr(traceback.format_exception(exc_type, exc_value,
                                              exc_traceback)))
        print("*** extract_tb:")
        print(repr(traceback.extract_tb(exc_traceback)))
        print("*** format_tb:")
        print(repr(traceback.format_tb(exc_traceback)))
        print("*** tb_lineno:", exc_traceback.tb_lineno)

この例の出力は次のようになります:

    *** print_tb:
      File "<doctest...>", line 10, in <module>
        lumberjack()
    *** print_exception:
    Traceback (most recent call last):
      File "<doctest...>", line 10, in <module>
        lumberjack()
      File "<doctest...>", line 4, in lumberjack
        bright_side_of_death()
    IndexError: tuple index out of range
    *** print_exc:
    Traceback (most recent call last):
      File "<doctest...>", line 10, in <module>
        lumberjack()
      File "<doctest...>", line 4, in lumberjack
        bright_side_of_death()
    IndexError: tuple index out of range
    *** format_exc, first and last line:
    Traceback (most recent call last):
    IndexError: tuple index out of range
    *** format_exception:
    ['Traceback (most recent call last):\n',
     '  File "<doctest...>", line 10, in <module>\n    lumberjack()\n',
     '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_death()\n',
     '  File "<doctest...>", line 7, in bright_side_of_death\n    return tuple()[0]\n',
     'IndexError: tuple index out of range\n']
    *** extract_tb:
    [<FrameSummary file <doctest...>, line 10 in <module>>,
     <FrameSummary file <doctest...>, line 4 in lumberjack>,
     <FrameSummary file <doctest...>, line 7 in bright_side_of_death>]
    *** format_tb:
    ['  File "<doctest...>", line 10, in <module>\n    lumberjack()\n',
     '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_death()\n',
     '  File "<doctest...>", line 7, in bright_side_of_death\n    return tuple()[0]\n']
    *** tb_lineno: 10

次の例は、スタックの print と format の違いを示しています:

    >>> import traceback
    >>> def another_function():
    ...     lumberstack()
    ...
    >>> def lumberstack():
    ...     traceback.print_stack()
    ...     print(repr(traceback.extract_stack()))
    ...     print(repr(traceback.format_stack()))
    ...
    >>> another_function()
      File "<doctest>", line 10, in <module>
        another_function()
      File "<doctest>", line 3, in another_function
        lumberstack()
      File "<doctest>", line 6, in lumberstack
        traceback.print_stack()
    [('<doctest>', 10, '<module>', 'another_function()'),
     ('<doctest>', 3, 'another_function', 'lumberstack()'),
     ('<doctest>', 7, 'lumberstack', 'print(repr(traceback.extract_stack()))')]
    ['  File "<doctest>", line 10, in <module>\n    another_function()\n',
     '  File "<doctest>", line 3, in another_function\n    lumberstack()\n',
     '  File "<doctest>", line 8, in lumberstack\n    print(repr(traceback.format_stack()))\n']

最後の例は、残りの幾つかの関数のデモをします:

    >>> import traceback
    >>> traceback.format_list([('spam.py', 3, '<module>', 'spam.eggs()'),
    ...                        ('eggs.py', 42, 'eggs', 'return "bacon"')])
    ['  File "spam.py", line 3, in <module>\n    spam.eggs()\n',
     '  File "eggs.py", line 42, in eggs\n    return "bacon"\n']
    >>> an_error = IndexError('tuple index out of range')
    >>> traceback.format_exception_only(type(an_error), an_error)
    ['IndexError: tuple index out of range\n']