"traceback" --- スタックトレースの表示または取得
************************************************

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

======================================================================

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

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

参考:

  Module "faulthandler"
     Used to dump Python tracebacks explicitly, on a fault, after a
     timeout, or on a user signal.

  Module "pdb"
     Interactive source code debugger for Python programs.

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

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(exc, /[, value, tb], limit=None, file=None, chain=True)

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

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

   * it prints the exception type and *value* after the stack trace

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

   Since Python 3.10, instead of passing *value* and *tb*, an
   exception object can be passed as the first argument. If *value*
   and *tb* are provided, the first argument is ignored in order to
   provide backwards compatibility.

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

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

   バージョン 3.10 で変更: The *etype* parameter has been renamed to
   *exc* and is now positional-only.

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)

   トレースバックオブジェクト *tb* から取り出された "前処理済み" スタ
   ックトレース項目のリストを表す "StackSummary" オブジェクトを返しま
   す。これはスタックトレースの異なる書式化を行うために役に立ちます。
   オプションの *limit* 引数は "print_tb()" の *limit* 引数と同様の意
   味を持っています。 "前処理済み" スタックトレース項目は 属性
   "filename", "lineno", "name", および "line" を含む "FrameSummary"
   オブジェクトで、スタックトレースに対して通常出力される情報を表して
   います。 "line" は前後の空白を取り除いた文字列です。ソースが利用で
   きない場合は "None" です。

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

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

traceback.format_list(extracted_list)

   "extract_tb()" または "extract_stack()" が返すタプルのリストまたは
   "FrameSummary" オブジェクトが与えられると、出力の準備を整えた文字列
   のリストを返します。結果として生じるリストの中の各文字列は、引数リ
   ストの中の同じインデックスの要素に対応します。各文字列は末尾に改行
   が付いています。さらに、ソーステキスト行が "None" でないそれらの要
   素に対しては、文字列は内部に改行を含んでいるかもしれません。

traceback.format_exception_only(exc, /[, value])

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

   Since Python 3.10, instead of passing *value*, an exception object
   can be passed as the first argument.  If *value* is provided, the
   first argument is ignored in order to provide backwards
   compatibility.

   バージョン 3.10 で変更: The *etype* parameter has been renamed to
   *exc* and is now positional-only.

traceback.format_exception(exc, /[, value, tb], limit=None, chain=True)

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

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

   バージョン 3.10 で変更: This function's behavior and signature were
   modified to match "print_exception()".

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 で追加.

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


"TracebackException" オブジェクト
=================================

バージョン 3.5 で追加.

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

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

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

   If *compact* is true, only data that is required by
   "TracebackException"'s "format" method is saved in the class
   attributes. In particular, the "__context__" field is calculated
   only if "__cause__" is "None" and "__suppress_context__" is false.

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

   __cause__

      元々の "__cause__" の "TracebackException"。

   __context__

      元々の "__context__" の "TracebackException"。

   __suppress_context__

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

   stack

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

   exc_type

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

   filename

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

   lineno

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

   end_lineno

      For syntax errors - the end line number where the error
      occurred. Can be "None" if not present.

      バージョン 3.10 で追加.

   text

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

   offset

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

   end_offset

      For syntax errors - the end offset into the text where the error
      occurred. Can be "None" if not present.

      バージョン 3.10 で追加.

   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" 例外の場合、構文例外が発生した箇所の詳細な情報を表
      す行を複数出します。

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

   バージョン 3.10 で変更: *compact* 引数が追加されました。


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


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


トレースバックの例
==================

この簡単な例では基本的な 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_life()

   def bright_side_of_life():
       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:")
       traceback.print_exception(exc_value, 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:")
       print(repr(traceback.format_exception(exc_value)))
       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_life()
   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_life()
   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_life()\n',
    '  File "<doctest...>", line 7, in bright_side_of_life\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_life>]
   *** format_tb:
   ['  File "<doctest...>", line 10, in <module>\n    lumberjack()\n',
    '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_life()\n',
    '  File "<doctest...>", line 7, in bright_side_of_life\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']
