Pythonで例外・エラーのクラス階層を出力する方法

Pythonの例外（Exception）やエラー（Error）のクラス階層を出力するには、標準ライブラリのinspectモジュールをインポートし、getclasstree()関数を使用します。

このコードでは、指定した例外クラスのリストを、ネストされたリストによる階層構造へと整理して出力します。__subclasses__()メソッドを再帰的にたどることで、出力例のように継承ツリーを下りながらすべてのクラス名をインデント付きで表示していきます。

仕組みのポイント

• inspect.getmro(BaseException)：BaseExceptionとその祖先クラス（objectなど）をタプルとして取得します。
• inspect.getclasstree()：取得したクラス群を、継承関係を表すネストされたリスト構造に変換します。
• cls.__subclasses__()：各クラスの直接のサブクラスを返すため、これを再帰的に呼び出せばツリー全体を走査できます。

コード例

import inspect
print "The class hierarchy for built-in exceptions is:"
inspect.getclasstree(inspect.getmro(BaseException))
def classtree(cls, indent=0):
    print '.' * indent, cls.__name__
    for subcls in cls.__subclasses__():
        classtree(subcls, indent + 3)
classtree(BaseException)

出力

このコードを実行すると、次のような出力が得られます。

The class hierarchy for built-in exceptions is:
BaseException
... Exception
...... StandardError
......... TypeError
......... ImportError
............ ZipImportError
......... EnvironmentError
............ IOError
............ OSError
............... WindowsError
......... EOFError
......... RuntimeError
............ NotImplementedError
......... NameError
............ UnboundLocalError
......... AttributeError
......... SyntaxError
............ IndentationError
............... TabError
......... LookupError
............ IndexError
............ KeyError
............ CodecRegistryError
......... ValueError
............ UnicodeError
............... UnicodeEncodeError
............... UnicodeDecodeError
............... UnicodeTranslateError
......... AssertionError
......... ArithmeticError
............ FloatingPointError
............ OverflowError
............ ZeroDivisionError
......... SystemError
............ CodecRegistryError
......... ReferenceError
......... MemoryError
......... BufferError
...... StopIteration
...... Warning
......... UserWarning
......... DeprecationWarning
......... PendingDeprecationWarning
......... SyntaxWarning
......... RuntimeWarning
......... FutureWarning
......... ImportWarning
......... UnicodeWarning
......... BytesWarning
...... _OptionError
...... error
...... Error
...... TokenError
...... StopTokenizing
...... error
...... EndOfBlock
... GeneratorExit
... SystemExit
... KeyboardInterrupt

補足：Python 3で実行する場合

上記のコードと出力はPython 2ベースのものです。Python 3ではprintが関数として扱われるため、print('.' * indent, cls.__name__)のように括弧を付けて記述します。また、Python 3ではStandardErrorが廃止されるなど例外階層にも変更があるため、実際の出力内容は上記とは異なる点に注意してください。