Python の例外とトレースバック情報

先日仕事で下記のような Python のコードを書いた。

try:
  # 例外が発生しうる何らかの処理
except Exception as exc:
  logger.exception("Something goes wrong..")
  raise exc

この実装は一度例外をインターセプトして独自のエラーメッセージを出力し、 その上で元の例外を上げ直すという動作を期待した、所謂ありふれたコードだ。

だが、レビューアーからは「その書き方だとトレースバックが上書きされてしまうので、 raise だけで良いよ」というようなコメントをいただいた。

本投稿ではこの学びを検証し、 また Python3 から使用できるようになった raise ... from ... の場合なども合わせて簡単な検証を行おうと思う。

結論

先に結論を記載しておく。

  • raise exc で元の例外オブジェクトを例外として挙げる方法でも Python3 であればスタックトレース内に元の例外発生箇所が含まれる。
    • ただし、raise exc している箇所の情報も出力される
  • raise だけを記載する方法は Python2 の時から有効な書き方で、スタックトレースもスマートに出力される
  • raise ... from ... は raise のみ記載した時と同様、スマートなスタックトレースが出力されるため、例外種別を切り替えたいときは積極的に利用していきたい記法である
  • raise ... from None は元の例外のスタックトレースを完全に上書きしてしまうので、かなり利用箇所が限定されるものと思う。
  • もうサポートが切れているので書くことは無いと願っているが、もしも Python2 で実装をする機会があれば、このようなシチュエーションにおいては raise exc するのではなく raise だけにしておくべきである。さもないと元の例外がどこで発生したのかという情報を失うこととなる。

検証するコード

patterns.py
import sys

# 検証１
def pattern_1():
  try:
    raise ValueError("エラーはここで発生")
  except Exception as exc:
    raise exc

# 検証２
def pattern_2():
  try:
    raise ValueError("エラーはここで発生")
  except Exception:
    raise

# 検証３
def pattern_3():
  try:
    raise ValueError("エラーはここで発生")
  except Exception as exc:
    raise Exception("新しいエラー") from exc

# 検証４
def pattern_4():
  try:
    raise ValueError("エラーはここで発生")
  except Exception:
    raise Exception("新しいエラー") from None

if __name__ == "__main__":
  patterns = {
    "p1": pattern_1,
    "p2": pattern_2,
    "p3": pattern_3,
    "p4": pattern_4,
  }
  patterns[sys.argv[1]]()

とりあえず上記 4 つのパターンを検証することにする。

Python 3.9.4

検証１

検証１は raise exc したときのスタックトレースを確認する

検証１
$ python patterns.py p1
# ->
# Traceback (most recent call last):
#   File "/home/k.s.k./Documents/misc/tmp/patterns.py", line 38, in <module>
#     patterns[sys.argv[1]]()
#   File "/home/k.s.k./Documents/misc/tmp/patterns.py", line 8, in pattern_1
#     raise exc
#   File "/home/k.s.k./Documents/misc/tmp/patterns.py", line 6, in pattern_1
#     raise ValueError("エラーはここで発生")
# ValueError: エラーはここで発生

どうやら raise ValueError("エラーはここで発生") という箇所 (line 6) もスタックトーレスに含まれるようである。 しかし line 8 で raise exc したという情報もスタックトレースに記載される。

検証２

検証２はレビューでおすすめされた記法である。このときのスタックトレースを確認する

検証２
$ python patterns.py p2
# ->
# Traceback (most recent call last):
#   File "/home/k.s.k./Documents/misc/tmp/patterns.py", line 38, in <module>
#     patterns[sys.argv[1]]()
#   File "/home/k.s.k./Documents/misc/tmp/patterns.py", line 13, in pattern_2
#     raise ValueError("エラーはここで発生")
# ValueError: エラーはここで発生

検証２のスタックトレースには raise で例外を再度発生させたという痕跡が残っておらず、 元のスタックトレースがそのまま出力されているかのようである。 影響を与えず例外をインタラプト出来ているという点で検証２のやり方はスマートである。

検証３

こちらは例外チェーンというやり方である。 raise の後に何かを記載することでスタックトレースの表記が上書きされてしまうのであれば、 Python3 で登場したこの例外チェーンは検証２のようなスマートなスタックトレースを出力する事が出来ないんだろうか。

検証３
$ python patterns.py p3
# ->
# Traceback (most recent call last):
#   File "/home/k.s.k./Documents/misc/tmp/patterns.py", line 20, in pattern_3
#     raise ValueError("エラーはここで発生")
# ValueError: エラーはここで発生
#
# The above exception was the direct cause of the following exception:
#
# Traceback (most recent call last):
#   File "/home/k.s.k./Documents/misc/tmp/patterns.py", line 38, in <module>
#     patterns[sys.argv[1]]()
#   File "/home/k.s.k./Documents/misc/tmp/patterns.py", line 22, in pattern_3
#     raise Exception("新しいエラー") from exc
# Exception: 新しいエラー

検証３のスタックトレースでは元の例外情報も表示しつつ、 元の例外によって raise Exception("新しいエラー") が引き起こされたという出力になる。 とても理解しやすい。

検証４

ドキュメントを読むと raise ... from None という書き方もあるらしい。

検証４
$ python patterns.py p4
# ->
# Traceback (most recent call last):
#   File "/home/k.s.k./Documents/misc/tmp/patterns.py", line 38, in <module>
#     patterns[sys.argv[1]]()
#   File "/home/k.s.k./Documents/misc/tmp/patterns.py", line 29, in pattern_4
#     raise Exception("新しいエラー") from None
# Exception: 新しいエラー

こちらは元の例外情報を完全に上書きしており、 用意した４つの検証の中で唯一 raise ValueError("エラーはここで発生") に対する記載がなかった。 どういうシチュエーションでここまで元のエラーを秘匿したいという要求が出るのかピンとこないが、 きっとどこかで (それこそ自分のコードをある程度汎用的なモジュールとして切り出す時とか？) こういう書き方が求められるんだろう。

Python 2.7.18

今となってはもうサポートの切れてしまった Python2 だが、 当時の例外とスタックトレースがどういう挙動になっていたのかも確認しておく。 なお、例外チェーンはシンタックスとして存在しないため検証３、４はコメントアウトしておく。 また中に日本語を含めているのでファイルの頭に -*- encoding:utf-8 -*- という懐かしいおまじないも追記する。

検証１

検証１
$ python patterns.py p1
# ->
# Traceback (most recent call last):
#   File "patterns.py", line 40, in <module>
#     patterns[sys.argv[1]]()
#   File "patterns.py", line 10, in pattern_1
#     raise exc
# ValueError: エラーはここで発生

raise exc している箇所はスタックトレースに表示される。 また元の ValueError: エラーはここで発生 も表示される。 だが、肝心の ValueError が発生した場所に関する出力が存在しない。。 これだとエラーログを見ても実際にはどの箇所で例外が上がったのかを特定するのが難しいケースも出てきそうである。

検証２

検証２
$ python patterns.py p2
# ->
# Traceback (most recent call last):
#   File "patterns.py", line 40, in <module>
#     patterns[sys.argv[1]]()
#   File "patterns.py", line 15, in pattern_2
#     raise ValueError("エラーはここで発生")
# ValueError: エラーはここで発生

こちらは Python3 のときと同様、とてもスマートなスタックトレースが出力されている。