Python
PR

Pythonの例外処理入門|try・except・finally・raiseの使い方

Pythonの例外処理入門|try・except・finally・raiseの使い方
hr
記事内に商品プロモーションを含む場合があります

Python のプログラムを動かしていると、Traceback (most recent call last): から始まる英語のメッセージが出て、途中で止まることがあります。これが例外(エラー)です。例外は「読めば原因が分かるもの」で、try と except を使えば、止めずに対処することもできます。

Windows 11 の Python 3.12 で実際に動かした結果つきで、次のことを解説します。

  • トレースバック(エラーの表示)を下から読むコツ
  • よく出る例外(ValueError・TypeError・KeyError など)の原因
  • try・except・else・finally の書き方と実行される順番
  • raise と raise … from、自作の例外クラス
  • except: と except Exception: の違い、例外を握りつぶす書き方の問題点

サンプルは、好きなフォルダーに sample.py などの名前で保存し、PowerShell などで py sample.py のように実行してください。トレースバックに出るファイルの場所は、読みやすいように C:\work\ に置き換えて載せています。

トレースバックの読み方:下から読む

まず、例外が起きたときの表示を読めるようにしましょう。次のプログラムは、文字列の価格を合計しようとして、”1,000″ のところで止まります。

def load_price(text):
    return int(text)

def total(prices):
    result = 0
    for p in prices:
        result += load_price(p)
    return result

print(total(["120", "80", "1,000"]))
Traceback (most recent call last):
  File "C:\work\tb.py", line 10, in <module>
    print(total(["120", "80", "1,000"]))
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\work\tb.py", line 7, in total
    result += load_price(p)
              ^^^^^^^^^^^^^
  File "C:\work\tb.py", line 2, in load_price
    return int(text)
           ^^^^^^^^^
ValueError: invalid literal for int() with base 10: '1,000'

1 行目の most recent call last は「最後に呼ばれたものが最後に書いてある」という意味です。つまり、いちばん下が、実際にエラーが起きた場所です。次の順に読みます。

  1. 最後の行で、例外の種類(ValueError)と理由を読む。ここでは「int() に変換できない文字列 ‘1,000’ が来た」
  2. そのすぐ上の File 行で、起きた場所を見る。tb.py の 2 行目、load_price 関数の中の int(text)。^^^^ の印が、問題の式を指しています
  3. さらに上へたどり、どこから呼ばれたかを見る。10 行目(<module> はファイルのいちばん外側)→ 7 行目の total → 2 行目の load_price の順に呼ばれた

直すべき場所は、いちばん下とは限りません。この例では、int() は正しく動いていて、カンマ入りの値を渡した側に問題があります。下から順に、自分の書いたファイルの行を探すのがコツです。ライブラリの中の行(...\Lib\json\decoder.py のような場所)が並んでいるときは、その上にある自分のファイルの行に注目します。

^^^^ の印は Python 3.11 で追加された表示で、3.10 以前では出ません。

よく出る例外と原因

エラーの種類が分かれば、原因の見当がつきます。それぞれの例外を int("abc")、"年齢: " + 20、{"name": "田中"}["age"]、[1, 2, 3][3]、存在しないファイルの open()、10 / 0、"日本語".encode("cp932").decode("utf-8") でわざと起こし、except Exception as e: で捕まえて種類とメッセージを表示しました。

ValueError: invalid literal for int() with base 10: 'abc'
TypeError: can only concatenate str (not "int") to str
KeyError: 'age'
IndexError: list index out of range
FileNotFoundError: [Errno 2] No such file or directory: 'no_such_file.txt'
ZeroDivisionError: division by zero
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x93 in position 0: invalid start byte
例外意味よくある原因
ValueError型は合っているが、値が不適切int(“abc”)、int(“1,000”) など数字でない文字列の変換
TypeError型が合わない文字列と数値を + でつなぐ。None を渡した
KeyError辞書にそのキーがないキー名の打ち間違い。JSON に項目がない
IndexErrorリストの範囲外の番号要素が 3 個なのに [3] を読む(番号は 0〜2)
FileNotFoundErrorファイルやフォルダーがない実行したフォルダーが違う。ファイル名の間違い
ZeroDivisionError0 で割った件数 0 のときの平均の計算
UnicodeDecodeError文字コードの読み違いShift_JIS のファイルを UTF-8 で読んだ(またはその逆)
AttributeErrorそのオブジェクトにない属性・メソッドNone.upper() のように、None に対して呼んだ
NameErrorその名前の変数・関数がない変数名の打ち間違い、定義する前に使った

UnicodeDecodeError の直し方は「Pythonのファイル読み書き」で詳しく解説しています。すでに文字化けしてしまったテキストは、文字化け復元ツールで元の文字を推測できることがあります。

例外には親子関係がある

例外はクラスで、親子関係(継承)があります。except 親クラス: と書くと、子クラスの例外もまとめて捕まえられます。組み込み例外の公式ドキュメントの一覧から、この記事に関係する部分を抜き出すと次のとおりです。

BaseException
 ├── KeyboardInterrupt      (Ctrl+C)
 ├── SystemExit             (sys.exit())
 └── Exception              (ふつうのエラーはすべてこの下)
      ├── ArithmeticError
      │    └── ZeroDivisionError
      ├── LookupError
      │    ├── IndexError
      │    └── KeyError
      ├── OSError
      │    └── FileNotFoundError
      ├── TypeError
      └── ValueError
           └── UnicodeError
                └── UnicodeDecodeError

たとえば UnicodeDecodeError は ValueError の子なので、except ValueError: でも捕まります。KeyboardInterrupt が Exception の下にないことは、あとの「except: と except Exception: の違い」で重要になります。

try・except の基本

例外が起きそうな処理を try: の中に書き、起きたときの処理を except 例外の種類: の中に書きます。例外が起きると、try の残りの行は飛ばされ、種類が合う except に移ります。

def divide(text):
    try:
        n = int(text)
        print(100 / n)
    except ValueError:
        print("数字ではありません")
    except ZeroDivisionError:
        print("0 では割れません")

divide("4")
divide("abc")
divide("0")
25.0
数字ではありません
0 では割れません

3 回とも、プログラムは止まらずに最後まで動きました。どの except にも合わない例外(たとえば divide(None) の TypeError)は捕まらず、ふだんどおりトレースバックが出て止まります。

複数の例外をまとめる・as e でメッセージを受け取る

同じ処理でよい例外は、(ValueError, ZeroDivisionError) のようにタプル(かっこで囲んだ組)で並べます。as e を付けると、例外のオブジェクトが変数 e に入り、メッセージや種類を調べられます。

for text in ["10", "x", "0"]:
    try:
        print(100 / int(text))
    except (ValueError, ZeroDivisionError) as e:
        print(type(e).__name__, "|", e)
10.0
ValueError | invalid literal for int() with base 10: 'x'
ZeroDivisionError | division by zero

かっこは必ず付けてください。Python 3.14 からは as を使わないときに限ってかっこを省けるようになりましたが(公式リファレンスの「Changed in version 3.14」で確認)、3.13 以前では文法エラーになります。

except は上から順に調べられる

except は上から順に調べられ、最初に合ったものだけが実行されます。親クラスを先に書くと、下の子クラスの except には来ません。たとえば except LookupError: の下に except KeyError: を書くと、KeyError は LookupError の子なので、上の except で捕まります(実行して確認しました)。

細かい種類(子)を上に、大まかな種類(親)を下に書きます。

else と finally:実行される順番

try には、else(例外が起きなかったときだけ実行)と finally(何があっても最後に実行)を付けられます。3 つの場合で、どこが実行されるかを確かめます。

def run(text):
    print(f"--- run({text!r})")
    try:
        print("try: 開始")
        n = int(text)
        print("try: 変換できた")
    except ValueError:
        print("except: 数字ではない")
    else:
        print("else: エラーなし", n)
    finally:
        print("finally: 必ず実行")
    print("try 文のあと")

run("5")
run("abc")
run(None)
--- run('5')
try: 開始
try: 変換できた
else: エラーなし 5
finally: 必ず実行
try 文のあと
--- run('abc')
try: 開始
except: 数字ではない
finally: 必ず実行
try 文のあと
--- run(None)
try: 開始
finally: 必ず実行
Traceback (most recent call last):
  File "C:\work\order.py", line 17, in <module>
    run(None)
  File "C:\work\order.py", line 5, in run
    n = int(text)
        ^^^^^^^^^
TypeError: int() argument must be a string, a bytes-like object or a real number, not 'NoneType'
場合実行される順番
例外が起きないtry(最後まで)→ else → finally → 次の行
except で捕まえたtry(途中まで)→ except → finally → 次の行
どの except にも合わないtry(途中まで)→ finally → 例外が呼び出し元へ伝わる(次の行は実行されない)

3 つ目のように、捕まえられなかった例外は finally を実行したあとで改めて発生します。finally は「ファイルや接続を必ず閉じる」「一時ファイルを必ず消す」といった後片付けに使います。

try、except ValueError、else、finally、try 文のあと の 5 つの部分が、run に 3 種類の値を渡したときにどう実行されるかの図。文字列 5 のときは try が最後まで実行され、except を飛ばして else、finally、try 文のあとが実行される。文字列 abc のときは try が ValueError で中断し、except、finally、try 文のあとが実行され、else は飛ばす。None のときは try が TypeError で中断し、合う except がないので except と else を飛ばし、finally を実行したあと TypeError で止まる。
図 1:try・except・else・finally が実行される順番

return があっても finally は実行される

try の中で return しても、関数を抜ける直前に finally が実行されます。注意が必要なのは、finally の中に return を書いた場合です。

def bad():
    try:
        return 1 / 0
    finally:
        return "finally の値"

print(bad())
finally の値

1 / 0 の ZeroDivisionError が消えてしまい、エラーにならずに “finally の値” が返りました。finally の中で return・break・continue を使うと例外が消えるため、公式チュートリアルでも勧められておらず、Python 3.14 からは警告(SyntaxWarning)が出るようになりました。finally には後片付けだけを書きます。

else を使う理由:try の中は短くする

次のプログラムは、”price” の有無を調べるつもりで、tax の行まで try に入れてしまった例です。

data = {"price": "100"}
try:
    price = int(data["price"])
    tax = int(data["tax"])
except KeyError:
    print("price がありません")

実行すると「price がありません」と表示されます。price はあるのに、です。実際に足りないのは “tax” です。守りたい行だけを try に入れ、続きの処理を else に移すと、関係のない KeyError を間違って捕まえなくなります。

data = {"price": "100"}
try:
    price = int(data["price"])
except KeyError:
    print("price がありません")
else:
    tax = int(data["tax"])

こう書き直して実行すると、今度は本当の原因 KeyError: 'tax' がトレースバックに表示されました。

with 文は「try・finally の後片付け」を自動でしてくれる

ファイルを開くときに使う with 文は、ブロックを抜けるときに、例外が起きても必ずファイルを閉じてくれます。公式リファレンスでも、with 文は try・except・finally のよくある使い方をまとめたもの、と説明されています。

with open("memo.txt", "w", encoding="utf-8") as f:
    f.write("1行目\n")

try:
    with open("memo.txt", encoding="utf-8") as f:
        for line in f:
            number = int(line)
except ValueError as e:
    print("エラー:", e)
print("閉じている?", f.closed)
エラー: invalid literal for int() with base 10: '1行目\n'
閉じている? True

with の中で ValueError が起きても、ファイルは閉じられています(True)。try・finally で close() を書くのと同じ後片付けを、書き忘れなく行えます。with は後片付けをするだけで、例外そのものは止めないので、エラーへの対処には try・except を組み合わせます。open() の使い方は「Pythonのファイル読み書き」を参照してください。

raise で例外を発生させる

自分のプログラムで「この値はおかしい」と判断したときは、raise で例外を発生させます。おかしな値のまま処理を続けるより、その場で止めた方が原因を見つけやすくなります。

def set_age(age):
    if age < 0:
        raise ValueError(f"年齢は 0 以上にしてください: {age}")
    return age

print(set_age(20))
set_age(-1)
20
Traceback (most recent call last):
  File "C:\work\raise1.py", line 7, in <module>
    set_age(-1)
  File "C:\work\raise1.py", line 3, in set_age
    raise ValueError(f"年齢は 0 以上にしてください: {age}")
ValueError: 年齢は 0 以上にしてください: -1

メッセージには、どの値がおかしかったかを入れておくと、トレースバックを見ただけで原因が分かります。また、except の中で引数なしの raise と書くと、捕まえた例外を元のトレースバックのまま投げ直せます(「メッセージを出してから止めたい」ときに使います)。

raise … from で「原因の例外」をつなぐ

except の中で別の例外を raise すると、Python は元の例外も一緒に表示します。from を付けるかどうかで、間の 1 行が変わります。

def get_port(config):
    try:
        return int(config["port"])
    except KeyError:
        raise RuntimeError("設定に port がありません")

get_port({})
Traceback (most recent call last):
  File "C:\work\ctx.py", line 3, in get_port
    return int(config["port"])
               ~~~~~~^^^^^^^^
KeyError: 'port'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "C:\work\ctx.py", line 7, in <module>
    get_port({})
  File "C:\work\ctx.py", line 5, in get_port
    raise RuntimeError("設定に port がありません")
RuntimeError: 設定に port がありません
書き方間に出る文意味
raise 新しい例外During handling of the above exception, another exception occurred:上の例外を処理している途中で、別の例外が起きた(except の中のバグにも見える)
raise 新しい例外 from eThe above exception was the direct cause of the following exception:上の例外が直接の原因で、意図して変換した
raise 新しい例外 from None(元の例外は表示されない)元の例外は見せる必要がない

例外を別の種類に変換するときは、from e を付けて「意図して変換した」ことを示すのがおすすめです。from None は、元の例外が読む人の役に立たないときだけ使います。raise RuntimeError("設定に port がありません") from None に変えて実行すると、KeyError の部分と間の 1 文が消え、RuntimeError のトレースバックだけが表示されました。

自作の例外クラスを作る

アプリ独自のエラーは、Exception を継承したクラスで作ります。名前は組み込み例外にならって「〜Error」にします(どちらも公式ドキュメントの推奨です)。中身は説明の文字列だけで十分です。

class ConfigError(Exception):
    """設定に問題があるときのエラー"""

def get_port(config):
    try:
        return int(config["port"])
    except KeyError as e:
        raise ConfigError("設定に port がありません") from e
    except ValueError as e:
        raise ConfigError(f"port が数字ではありません: {config['port']!r}") from e

for config in [{"port": "8080"}, {}, {"port": "80a"}]:
    try:
        print("port =", get_port(config))
    except ConfigError as e:
        print("設定エラー:", e, "/ 元の例外:", repr(e.__cause__))
port = 8080
設定エラー: 設定に port がありません / 元の例外: KeyError('port')
設定エラー: port が数字ではありません: '80a' / 元の例外: ValueError("invalid literal for int() with base 10: '80a'")

呼び出す側は、KeyError か ValueError かを気にせず、except ConfigError: だけで設定の問題をまとめて扱えます。from e で付けた元の例外は e.__cause__ に入っています。エラーの種類が増えてきたら、アプリ共通の親クラス(例:class AppError(Exception):)を作り、ConfigError などをその子にすると、まとめて捕まえやすくなります。BaseException を直接継承するのは避けてください(理由は次の節で説明します)。

except: と except Exception: の違い

種類を書かない素の except: は、すべての例外を捕まえます。これには、Ctrl+C で止めたときの KeyboardInterrupt や、sys.exit() で終了するときの SystemExit も含まれます。一方 except Exception: は、Exception の子だけを捕まえるので、この 2 つは捕まえません。

違いを確かめるため、ループの途中で Ctrl+C を押したのと同じ状態を作ってみます(_thread.interrupt_main() で KeyboardInterrupt を起こす実験用のコードです)。

import _thread, threading, time

# 実験用:1.5 秒後に Ctrl+C を押したのと同じ状態にする
threading.Timer(1.5, _thread.interrupt_main).start()

for i in range(1, 5):
    try:
        print(i, "回目の処理")
        time.sleep(1)
    except Exception:
        print("  エラーを無視して続行")
print("ループ終了")
1 回目の処理
2 回目の処理
Traceback (most recent call last):
  File "C:\work\kbi_exc.py", line 9, in <module>
    time.sleep(1)
KeyboardInterrupt

except Exception: では KeyboardInterrupt が捕まらず、ちゃんと止まりました。except Exception: を except: に変えると、次のようになります。

1 回目の処理
2 回目の処理
  エラーを無視して続行
3 回目の処理
4 回目の処理
ループ終了

Ctrl+C が「エラー」として握りつぶされ、止められなくなりました。sys.exit() も素の except で捕まり、終了できなくなることを確認しました。公式ドキュメントにも、KeyboardInterrupt と SystemExit は「Exception を捕まえるコードにうっかり捕まらないように」BaseException の子になっている、とあります。

まとめると、素の except: は使わない、どうしても広く捕まえるなら except Exception:、できれば except ValueError: のように種類を絞る、が基本です。

アンチパターン:例外を握りつぶす

「とりあえずエラーが出なくなる」ので書いてしまいがちなのが、except: pass です。

def load_users(path):
    try:
        with open(path, encoding="utf-8") as f:
            return [line.strip() for line in f]
    except:
        pass

users = load_users("users.txt")
print(len(users))
Traceback (most recent call last):
  File "C:\work\swallow.py", line 9, in <module>
    print(len(users))
          ^^^^^^^^^^
TypeError: object of type 'NoneType' has no len()

本当の原因は「users.txt がない(FileNotFoundError)」なのに、表示されたのは別の場所の TypeError です。except: pass で例外が消え、関数が None を返したためです。原因の手がかりが消え、エラーが遠い場所で別の形になって現れるので、調査がとても難しくなります。

ファイルがないのが想定内なら、その例外だけを捕まえ、何をするかを明示します。

def load_users(path):
    try:
        with open(path, encoding="utf-8") as f:
            return [line.strip() for line in f]
    except FileNotFoundError:
        print(f"{path} がないので、空の一覧で始めます")
        return []

users = load_users("users.txt")
print(len(users))
users.txt がないので、空の一覧で始めます
0
避けたい書き方問題代わりの書き方
except: pass原因が消える。Ctrl+C でも止まらなくなる想定内の種類だけ捕まえ、処理を書く
except Exception: passバグ(打ち間違いの NameError など)まで隠れる捕まえるならメッセージを出す・ログに残す
関数全体を try で囲むどの行のエラーか分からない。関係ない例外も捕まるtry は守りたい行だけ。続きは else に
print(e) だけで処理を続けるおかしな状態のまま次へ進む続けられないなら raise で投げ直す

公式チュートリアルでも、捕まえる種類はできるだけ具体的にし、想定外の例外は伝わるようにすること、Exception を捕まえるならメッセージやログに出してから投げ直すのがよくある形であることが説明されています。

ExceptionGroup と except*(Python 3.11 以降)

Python 3.11 で、複数の例外をまとめて投げる ExceptionGroup と、その中から種類ごとに取り出す except* が追加されました(Python 3.11 の「What’s New」の PEP 654 で確認)。入力チェックで見つかったエラーを全部まとめて返したいときや、並行処理(asyncio の TaskGroup など)で複数の処理が同時に失敗したときに使われます。

def check(form):
    errors = []
    if not form.get("name"):
        errors.append(ValueError("名前が空です"))
    if not isinstance(form.get("age"), int):
        errors.append(TypeError("年齢は整数で指定してください"))
    if errors:
        raise ExceptionGroup("入力エラーがあります", errors)

try:
    check({"name": "", "age": "20"})
except* ValueError as eg:
    for e in eg.exceptions:
        print("ValueError:", e)
except* TypeError as eg:
    for e in eg.exceptions:
        print("TypeError:", e)
ValueError: 名前が空です
TypeError: 年齢は整数で指定してください

ふつうの except と違い、合う except* がすべて実行されます(ここでは ValueError と TypeError の両方)。eg も ExceptionGroup で、中の例外は eg.exceptions で取り出します。

まとめ

  • トレースバックは下から読む。最後の行で種類と理由、その上で場所を確認する
  • except には種類を書き、try は守りたい行だけにする。続きは else、後片付けは finally か with
  • 例外を変換するときは raise … from e。自作の例外は Exception を継承する
  • 素の except: と except: pass は使わない

関連する記事・ツール

ABOUT ME
hr
hr
エンジニアとして働いている hr です。仕事や資格勉強で「こんなツールがあれば」と感じたものを、無料Webツールと解説記事にして発信しています。
記事URLをコピーしました