Python中級

中級 Pythonで学ぶ例外設計｜ケーススタディ編

 

導入

例外設計は、ソフトウェア開発において重要な要素です。特に中級エンジニアにとっては、エラーハンドリングの設計がシステムの安定性や可読性に直結します。このケーススタディでは、架空のオンラインストアを舞台に、実際の業務で遭遇しやすい例外設計の課題に焦点を当てていきます。

教科書レベルの解説（例外設計）

重要な概念の整理

例外設計とは、プログラムが予期しない状況に直面した際に、適切に対処するための設計手法です。これには、例外を捕捉し、エラーメッセージをユーザーに伝えること、またはログに記録することが含まれます。例外設計の目標は、システムの信頼性を高め、ユーザー体験を向上させることです。

コード例（Python）


class ProductNotFoundError(Exception):
    pass

class Inventory:
    def __init__(self):
        self.products = {}

    def add_product(self, product_id, quantity):
        self.products[product_id] = quantity

    def get_product(self, product_id):
        if product_id not in self.products:
            raise ProductNotFoundError(f"Product with ID {product_id} not found.")
        return self.products[product_id]

inventory = Inventory()
inventory.add_product('apple', 10)

try:
    print(inventory.get_product('banana'))
except ProductNotFoundError as e:
    print(e)

コードの行ごとの解説

  1. class ProductNotFoundError(Exception): 独自の例外クラスを定義します。このクラスは、特定のエラーを示すために使用されます。
  2. class Inventory: 在庫管理を行うクラスです。このクラスの中で製品の追加や取得を行います。
  3. def add_product(self, product_id, quantity): 新しい製品を在庫に追加するメソッドです。
  4. def get_product(self, product_id): 製品を取得するメソッドですが、製品が存在しない場合には独自の例外を発生させます。
  5. if product_id not in self.products: 製品の存在を確認します。
  6. raise ProductNotFoundError: 製品が見つからない場合に、独自の例外を発生させます。
  7. try: 例外が発生する可能性のあるコードブロックを囲みます。
  8. except ProductNotFoundError as e: 発生した例外を捕捉し、エラーメッセージを表示します。

ケーススタディ編

オンラインストアを運営する企業が、新しい商品を追加する機能を開発しています。この機能では、製品IDを指定して在庫を管理します。しかし、ユーザーが存在しない製品IDを入力した場合、システムが適切にエラー処理を行わなければなりません。ここでの落とし穴は、ユーザーに対して不明瞭なエラーメッセージを表示してしまうことです。例えば、「製品が見つかりませんでした」というメッセージだけでは、ユーザーは何をすべきか分からないかもしれません。

この問題を解決するために、エラーメッセージを具体的にし、ユーザーが次に何をすればよいかを示すことが重要です。例えば、「指定された製品IDは存在しません。正しいIDを確認してください。」というメッセージに変更することで、ユーザーの理解を助けることができます。

まとめ

  • 例外設計は、ユーザーに対するエラーメッセージの明確さが重要です。
  • 独自の例外クラスを作成することで、特定のエラーを効果的に管理できます。
  • 実際のプロジェクトでの例外処理は、ユーザー体験に大きく影響します。
RELATED POST