Pythonで独自例外を定義する方法まとめ(Exception継承)

# 最小の独自例外の定義と、未捕捉時の挙動を確認する例

class MyError(Exception):
    """アプリ固有のエラーを表す最小の例外クラス"""
    pass

def run():
    # 何らかのエラー条件を検出したと仮定して、意図的に発生させる
    raise MyError("何かがうまくいきませんでした")

run()  # try-exceptで捕まえないので、Tracebackが表示される

# メッセージと関連情報を属性で持たせる例
# 文字列だけでなく、原因のキーやIDなどを属性で渡すと、機械可読なハンドリングが可能

class ConfigKeyMissingError(Exception):
    """設定ファイルの必須キーが欠落していることを表す例外"""
    def __init__(self, key: str, *, filepath: str | None = None):
        self.key = key
        self.filepath = filepath
        # 親クラスにメッセージを渡す。str(e) 時はこのメッセージが使われる
        msg = f"必須キーが見つかりません: key={key}"
        if filepath:
            msg += f" (file={filepath})"
        super().__init__(msg)

def load_config():
    # ダミー: 必須キー "token" がないと仮定
    raise ConfigKeyMissingError("token", filepath="settings.toml")

try:
    load_config()
except ConfigKeyMissingError as e:
    # 例外オブジェクトから属性を取り出して用途別に処理できる
    print("短いメッセージ:", str(e))
    print("欠落キー:", e.key)
    print("ファイル:", e.filepath)

# ライブラリ "acme" を想定した基底例外とサブクラス群の例

class AcmeError(Exception):
    """acmeライブラリ全般の基底例外"""
    pass

class AcmeConfigError(AcmeError):
    """設定関連のエラー"""
    pass

class AcmeAPIError(AcmeError):
    """外部API呼び出し関連のエラー"""
    def __init__(self, status: int, message: str = "API error"):
        self.status = status
        super().__init__(f"{message} (status={status})")

def call_api():
    # ダミー: 503エラーが返ってきた
    raise AcmeAPIError(503, "Service Unavailable")

try:
    call_api()
except AcmeAPIError as e:
    print("APIだけ個別にリトライ:", e)
except AcmeError as e:
    # 他のacmeエラーはまとめて処理
    print("acmeの一般的なエラー:", e)

# 例外の送出と、原因例外のチェイニング(raise from)の例

class ConfigParseError(Exception):
    pass

def parse_token(d: dict) -> str:
    try:
        # dictからtokenを取り出すが、キーがなければKeyErrorが起きる
        return d["token"]
    except KeyError as e:
        # 原因(KeyError)を保ったまま、より意味のある例外に変換
        raise ConfigParseError("設定からtokenを読み取れませんでした") from e

# デモ
try:
    parse_token({"user": "alice"})  # "token" がない
except ConfigParseError as e:
    print("アプリ向けのわかりやすい例外:", e)

class PaymentError(Exception):
    pass

class InsufficientBalanceError(PaymentError):
    pass

def charge(balance: int, amount: int):
    if amount > balance:
        raise InsufficientBalanceError("残高不足です")
    print("決済に成功しました")

try:
    charge(balance=100, amount=120)
except InsufficientBalanceError as e:
    print("残高を確認して再実行してください:", e)
except PaymentError as e:
    print("支払いに関する一般的なエラー:", e)

class AppError(Exception):  # 広い
    pass

class DataError(AppError):  # 狭い
    pass

class NetworkError(AppError):  # 狭い
    pass

def do_task(kind: str):
    if kind == "data":
        raise DataError("データ形式が不正")
    elif kind == "net":
        raise NetworkError("タイムアウト")
    else:
        print("正常終了")

for k in ("data", "net", "ok"):
    try:
        do_task(k)
    except DataError as e:           # まず狭い型
        print("[DATA] 再フォーマットを試行:", e)
    except NetworkError as e:        # 次に別の狭い型
        print("[NET] リトライ待機:", e)
    except AppError as e:            # 最後に広い型
        print("[APP] 一般処理:", e)

# 意味があいまいで、外部から見るとRuntimeErrorと区別がつかない
class MyRuntimeError(RuntimeError):
    pass

class SpreadsheetImportError(Exception):
    """スプレッドシートの取り込みに失敗したことを表す"""
    pass

class CustomerNotFoundError(Exception):
    def __init__(self, customer_id: str):
        self.customer_id = customer_id
        super().__init__(f"顧客が見つかりません: id={customer_id}")

# 良くない: 通常フローで例外を多用
def get_price_bad(d: dict) -> int:
    try:
        return d["price"]
    except KeyError:
        return 0  # 本当に0で良いのか判別しづらい

# 良い: 通常は明示的に分岐、足りない時だけ例外
def get_price_good(d: dict) -> int:
    if "price" in d:
        return d["price"]
    raise KeyError("priceが存在しません")

class ReportGenerationError(Exception):
    pass

def generate_report(path: str) -> str:
    """
    指定パスからレポートを生成して、出力ファイルのパスを返します。

    Raises:
        FileNotFoundError: 入力ファイルが見つからない場合
        PermissionError: 出力先に書き込めない場合
        ReportGenerationError: レポート生成の内部エラー一般
    """
    try:
        # ダミー: 何かの内部処理
        raise ValueError("内部の整合性エラー")
    except ValueError as e:
        # 利用者にとって意味のある例外に変換して公開
        raise ReportGenerationError("レポート生成に失敗しました") from e

try:
    generate_report("input.csv")
except FileNotFoundError:
    print("入力ファイルを確認してください")
except ReportGenerationError as e:
    print("生成処理の失敗:", e)