#
8. エラーと例外

これまでエラーメッセージについては簡単に触れるだけでしたが、チュートリアル 中の例を自分で試していたら、実際にいくつかのエラーメッセージを見ている ことでしょう。エラーには (少なくとも) 二つのはっきり異なる種類があります: それは 構文エラー (syntax error) と例外 (exception) です。

#
8.1 構文エラー

構文エラーは構文解析エラー (parsing error) としても知られており、 まだ Python を学習中なら、おそらくもっともよく受け取る種の文句でしょう:

    >>> while True print 'Hello world'
      File "<stdin>", line 1, in ?
        while True print 'Hello world'
                       ^
    SyntaxError: invalid syntax

パーサは違反の起きている行を繰り返し、小さな `矢印' を表示して、 違反の起きている行中でエラーが検出された最初の位置を示します。 エラーは矢印の直前の トークンでひき起こされています (または、 少なくともそこで検出されています)。 上述の例の中では、エラーは `print` で検出されています。 コロン ("`:`") がその前に無いからです。 入力がスクリプトから来ている場合は、どこを見ればよいか分かるように ファイル名と行番号が出力されます。

#
8.2 例外

たとえ文や式が構文的に正しくても、実行しようとしたときにエラーが 発生するかもしれません。 実行中に検出されたエラーは 例外 (exception) と呼ばれ、 常に致命的とは限りません: Python プログラムで例外をどのように扱うかは、 すぐに習得することでしょう。ほとんどの例外はプログラムで処理されず、 以下に示されるようなメッセージになります:

    >>> 10 * (1/0)
    Traceback (most recent call last):
      File "<stdin>", line 1, in ?
    ZeroDivisionError: integer division or modulo by zero
    >>> 4 + spam*3
    Traceback (most recent call last):
      File "<stdin>", line 1, in ?
    NameError: name 'spam' is not defined
    >>> '2' + 2
    Traceback (most recent call last):
      File "<stdin>", line 1, in ?
    TypeError: cannot concatenate 'str' and 'int' objects

エラーメッセージの最終行は何が起こったかを示しています。 例外は様々な例外型 (type) で起こり、その型がエラーメッセージの 一部として出力されます: 上の例での型は `ZeroDivisionError`, `NameError`, `TypeError` です。 例外型として出力される文字列は、発生した組み込み例外の名前です。 これは全ての組み込み例外について成り立ちますが、 ユーザ定義の例外では (成り立つようにするのは有意義な慣習ですが) 必ずしも成り立ちません。 標準例外の名前は組み込みの識別子です (予約語ではありません)。

残りの行は例外の詳細で、その解釈は例外の型に依存します; これらの行の意味するところは例外の型に依存します。

エラーメッセージの先頭部分では、例外が発生した実行コンテキスト (context) を、スタックのバックトレース (stack backtrace) の 形式で示しています。一般には、この部分にはソースコード行を リストしたバックトレースが表示されます; しかし、標準入力から 読み取られた行については表示しません。

Python ライブラリリファレンス には、組み込み例外とその意味がリストされています。

#
8.3 例外を処理する

例外を選別して処理するようなプログラムを書くことができます。 以下の例を見てください。この例では、有効な文字列が入力されるまで ユーザに入力を促しますが、ユーザがプログラムに (`Control-C` か、またはオペレーティングシステムがサポート している何らかのキーを使って) 割り込みをかけてプログラムを 中断させることができるようにしています; ユーザが生成した割り込みは、 `KeyboardInterrupt` 例外が送出されることで通知される ということに注意してください。

    >>> while True:
    ...     try:
    ...         x = int(raw_input("Please enter a number: "))
    ...         break
    ...     except ValueError:
    ...         print "Oops! That was no valid number.  Try again..."
    ...

`try` 文は下記のように動作します。

- まず、 try 節 (try clause) (キーワード `try` と `except` のあいだの文) が実行されます。

- 何も例外が発生しなければ、except 節 をスキップして `try` 文の実行を終えます。

- try 節内の実行中に例外が発生すると、その節の残りは飛ばされます。 次に、例外型が `except` キーワードの後に指定されている 例外に一致する場合、try 節の残りはスキップして、 except 節が実行 された後、 `try` 節の後の文に実行が継続されます。

- もしも except 節で指定された例外と一致しない例外が発生すると、 その例外は `try` 文の外側に渡されます。例外に対する ハンドラ (handler、処理部) がどこにもなければ、 処理されない例外 (unhandled exception) となり、 上記に示したようなメッセージを出して実行を停止します。

一つの `try` 文に複数の except 節を設けて、さまざまな例外に 対するハンドラを指定することができます。同時に一つ以上のハンドラが 実行されることはありません。ハンドラは対応する try 節内で発生した 例外だけを処理し、同じ try 節内の別の例外ハンドラで起きた例外は 処理しません。except 節には複数の例外を丸括弧で囲ったリストにして 渡すことができます。例えば以下のようにします:

    ... except (RuntimeError, TypeError, NameError):
    ...     pass

最後の except 節では例外名を省いて、ワイルドカード (wildcard、総称記号) にすることができます。ワイルドカードの except 節は非常に注意して使って ください。というのは、ワイルドカードは通常のプログラムエラーをたやすく 隠してしまうからです！ワイルドカードの except 節はエラーメッセージを 出力した後に例外を再送出する (関数やメソッドの呼び出し側が同様にして 例外を処理できるようにする) 用途にも使えます:

    import sys

    try:
        f = open('myfile.txt')
        s = f.readline()
        i = int(s.strip())
    except IOError, (errno, strerror):
        print "I/O error(%s): %s" % (errno, strerror)
    except ValueError:
        print "Could not convert data to an integer."
    except:
        print "Unexpected error:", sys.exc_info()[0]
        raise

`try` ... `except` 文には、オプションで else 節 (else clause) を設けることができます。`else` 節を設ける場合、全ての `except` 節よりも後ろに置かねばなりません。 `except` 節は、try 節で全く例外が送出されなかったときに 実行されるコードを書くのに役立ちます。例えば以下のようにします:

    for arg in sys.argv[1:]:
        try:
            f = open(arg, 'r')
        except IOError:
            print 'cannot open', arg
        else:
            print arg, 'has', len(f.readlines()), 'lines'
            f.close()

追加のコードを追加するのは `try` 節の後ろよりも `else` 節の方がよいでしょう。なぜなら、そうすることで `try` ... `except` 文で保護したいコードから 送出されたもの以外の例外を偶然に捕捉してしまうという事態を避けられる からです。

例外が発生するとき、例外に関連付けられた値を持つことができます。 この値は例外の例外の引数 (argument) としても知られています。 引数の有無と引数の型がどうなっているかは例外の型に依存します。

except 節では、例外名 (または例外名リスト) の後に変数を指定することが できます。この変数は例外インスタンスに結び付けられており、 `instance.args` に例外インスタンス生成時の引数が入っています。 例外インスタンスには `__getitem__` および `__str__` が 定義されており、`.args` を参照しなくても引数に直接アクセスしたり 印字したりできるように利便性が図られています。

    >>> try:
    ...    raise Exception('spam', 'eggs')
    ... except Exception, inst:
    ...    print type(inst)     # 例外インスタンス
    ...    print inst.args      # .args に記憶されている引数
    ...    print inst           # __str__ で引数を直接出力できる
    ...    x, y = inst          # __getitem__ で引数を直接アンパックできる
    ...    print 'x =', x
    ...    print 'y =', y
    ...
    <type 'instance'>
    ('spam', 'eggs')
    ('spam', 'eggs')
    x = spam
    y = eggs

処理されない例外の場合、例外が引数を持っていれば、メッセージの 最後の (`詳細説明の') 部分に出力されます。

例外ハンドラは、try 節でじかに発生した例外を処理するだけではなく、 その try 節から呼び出された関数の内部で発生した例外も処理します (間接的に呼ばれていてもです) 。例えば:

    >>> def this_fails():
    ...     x = 1/0
    ...
    >>> try:
    ...     this_fails()
    ... except ZeroDivisionError, detail:
    ...     print 'Handling run-time error:', detail
    ...
    Handling run-time error: integer division or modulo

#
8.4 例外を送出する

`raise` 文を使うと、プログラマは指定した例外を強制的に 送出させられます。例えば:

    >>> raise NameError, 'HiThere'
    Traceback (most recent call last):
      File "<stdin>", line 1, in ?
    NameError: HiThere

`raise` の第一引数には、ひき起こすべき例外を指定します。 オプションの第二引数では例外の引数を指定します。

例外が発生したかどうかは判定したいが、その処理を行おうとは思っていない 場合、単純な形式の `raise` 文を使って例外を再送出させることが できます:

    >>> try:
    ...     raise NameError, 'HiThere'
    ... except NameError:
    ...     print 'An exception flew by!'
    ...     raise
    ...
    An exception flew by!
    Traceback (most recent call last):
      File "<stdin>", line 2, in ?
    NameError: HiThere

#
8.5 ユーザ定義の例外

プログラム上で新しい例外クラスを作成することで、独自の例外を指定する ことができます。例外は、典型的に `Exception` クラスから、 直接または間接的に導出したものです。例えば:

    >>> class MyError(Exception):
    ...     def __init__(self, value):
    ...         self.value = value
    ...     def __str__(self):
    ...         return repr(self.value)
    ...
    >>> try:
    ...     raise MyError(2*2)
    ... except MyError, e:
    ...     print 'My exception occurred, value:', e.value
    ...
    My exception occurred, value: 4
    >>> raise MyError, 'oops!'
    Traceback (most recent call last):
      File "<stdin>", line 1, in ?
    __main__.MyError: 'oops!'

例外クラスでは、他のクラスができることなら何でも定義することが できますが、通常は単純なものにしておきます。たいていは、いくつかの 属性だけを提供し、例外が発生したときにハンドラがエラーに関する情報 を取り出せるようにする程度にとどめます。 複数の別個の例外を送出するようなモジュールを作成する際には、 そのモジュールで定義されている例外の基底クラスを作成するのが 一般的なならわしです:

    class Error(Exception):
        """Base class for exceptions in this module."""
        pass

    class InputError(Error):
        """Exception raised for errors in the input.

        Attributes:
            expression -- input expression in which the error occurred
            message -- explanation of the error
        """

        def __init__(self, expression, message):
            self.expression = expression
            self.message = message

    class TransitionError(Error):
        """Raised when an operation attempts a state transition that's not
        allowed.

        Attributes:
            previous -- state at beginning of transition
            next -- attempted new state
            message -- explanation of why the specific transition is not allowed
        """

        def __init__(self, previous, next, message):
            self.previous = previous
            self.next = next
            self.message = message

ほとんどの例外は、標準の例外の名前付けと同様に、 ``Error,'' で終わる名前で定義されています。

多くの標準モジュールでは、モジュールで定義されている関数内で発生する 可能性のあるエラーを報告させるために、独自の例外を定義しています。 クラスについての詳細な情報は 9 章、 ``クラス'' で 提供されています。

#
8.6 後片付け動作を定義する

`try` 文にはもう一つオプションの節があります。この節は クリーンアップ動作を定義するためのもので、どんな状況でも必ず 実行されます。例えば:

    >>> try:
    ...     raise KeyboardInterrupt
    ... finally:
    ...     print 'Goodbye, world!'
    ...
    Goodbye, world!
    Traceback (most recent call last):
      File "<stdin>", line 2, in ?
    KeyboardInterrupt

finally 節 (finally clause) は、 try 節で例外が発生したかどうかに関係なく実行されます。 例外が発生した時は、finally 節を実行した後、その例外を再送出します。 finally 節はまた、`try` 文から `break` 文や `return` 文経由で抜ける際にも、 ``抜ける途中で'' 実行されます。

finally 節中のコードは (ファイルやネットワーク接続のような) 外部の資源 について、資源の利用が成功したかどうかに関係なく解放を行うのに便利です。

`try` 文には、一個以上の except 節か、または一個の finally 節を持たねばなりませんが、両方持つことはできません。