効果的な例外処理コードを記述することは、堅牢で保守可能なアプリケーションを作成するために不可欠です。
以下は、Python で例外処理コードを記述するためのベスト プラクティスです:

1. 扱えるものだけを捕まえる

具体的に指定してください:

• 広範なExcept句を使用するのではなく、特定の例外をキャッチします。
• これにより、予期し、処理方法がわかっている例外のみが確実にキャッチされます。

try:
    # Code that might raise an exception
except ValueError as e:
    print(f"Value error occurred: {e}")

2. 以下の条項を除いてベアを避ける

特定の例外をキャッチします:

• 例外タイプを指定せずに、Except: を使用することは避けてください。
• これにより、予期しないエラーが検出され、デバッグが困難になる可能性があります。

try:
    # Code that might raise an exception
except Exception as e:  # Catch all exceptions if necessary
    print(f"An error occurred: {e}")

3. try-excel-else-finally ブロックを使用する

• try: 例外を発生させる可能性のあるコードをここに配置します。
• 例外: このブロックで例外を処理します。
• else: try ブロックで例外が発生しなかった場合、このブロックを実行します。
• finally: 例外が発生したかどうかに関係なく、このブロックを実行します。クリーンアップによく使用されます。

try:
    # Code that might raise an exception
except ValueError as e:
    print(f"Value error: {e}")
else:
    print("No exceptions occurred.")
finally:
    print("This will always be executed.")

4. 例外をログに記録する

• ロギング モジュールを使用して例外を記録します。
• ログは、エンド ユーザーにエラーを明らかにすることなく、運用環境の問題を診断するのに役立ちます。

import logging

logging.basicConfig(level=logging.ERROR)

try:
    # Code that might raise an exception
except Exception as e:
    logging.error(f"An error occurred: {e}")

5. 必要に応じて例外を再発生させる

• 例外をキャッチしても完全に処理できない場合は、別の場所で処理できるように例外を再発生させることを検討してください。

try:
    # Code that might raise an exception
except ValueError as e:
    logging.error(f"Value error: {e}")
    raise  # Re-raise the exception

6. リソース管理にコンテキストマネージャーを使用する

• コンテキスト マネージャー (ステートメント付き) を使用して、ファイル、ソケット、データベース接続などのリソースを管理します。
• これにより、例外が発生した場合でもリソースが適切に解放されることが保証されます。

with open('file.txt', 'r') as file:
    content = file.read()

7. グレースフルデグラデーション

- アプリケーションのクラッシュを許可する代わりに、フォールバック メカニズムやユーザー フレンドリーなエラー メッセージを提供します。

• たとえば、構成ファイルが見つからない場合は、代わりにデフォルト設定を使用できます。

try:
    with open('config.json', 'r') as file:
        config = json.load(file)
except FileNotFoundError:
    print("Config file not found, using defaults.")
    config = {"default": "value"}

8. 例外を飲み込まないようにする

• 何もアクションを起こさずに例外をキャッチしません。
• 例外を無視するとバグが隠れ、アプリケーションが予期しない動作をする可能性があります。

try:
    # Code that might raise an exception
except Exception as e:
    pass  # Bad practice - you're ignoring the error

9. 文書の例外

• 関数で発生する可能性のある例外を文書化するには、ドキュメント文字列を使用します。
• これは、他の開発者がどのような例外が予想され、その例外をどのように処理するかを理解するのに役立ちます。

def divide(a, b):
    """
    Divides two numbers.

    :param a: Numerator.
    :param b: Denominator.
    :return: The result of the division.
    :raises ZeroDivisionError: If the denominator is zero.
    """
    if b == 0:
        raise ZeroDivisionError("Cannot divide by zero.")
    return a / b

10. 適切な場合はカスタム例外を使用する

• アプリケーション内の特定のエラー条件を表すカスタム例外を作成します。
• これにより、コードが読みやすくなり、保守が容易になります。

class InvalidInputError(Exception):
    """Exception raised for invalid inputs."""
    pass

def process_input(value):
    if not isinstance(value, int):
        raise InvalidInputError("Input must be an integer.")
    return value * 2

11. テスト例外処理

• 例外処理が期待どおりに動作することを確認するテストを作成します。
• unittest や pytest などのフレームワークを使用して、通常のケースと例外的なケースの両方をテストします。

def test_divide():
    assert divide(10, 2) == 5
    with pytest.raises(ZeroDivisionError):
        divide(10, 0)

12. 例外の乱用を避ける

例外的なケースには例外を使用します:

• 例外は、通常の制御フロー メカニズムとしてではなく、予期せぬ状況に対して使用する必要があります。
• たとえば、ループの終了などの予測可能な条件を処理するために例外を使用することは避けてください。

# Bad practice: using exceptions for control flow
try:
    while True:
        value = next(iterator)
except StopIteration:
    pass  # End of iteration

13. コンテキストの例外を連鎖させる

• Python では、新しい例外を発生させるときに元のコンテキストを保持するために例外を連鎖させることができます。
• 関連する例外をリンクするには from を使用します。

try:
    result = process_input(input_value)
except InvalidInputError as e:
    raise ValueError("Failed to process input") from e

これらのベスト プラクティスに従うことで、エラーを適切に管理し、アプリケーションの信頼性を高める、より堅牢で保守しやすく、読みやすい例外処理コードを作成できます。

資源

• 例外処理に関する Python の公式ドキュメント
• Python のロギング モジュールのドキュメント
• PEP 8 - Python コードのスタイル ガイド (例外を含む一般的なコーディングの実践用)
• 本物の Python - 例外処理