コードの再利用性を高めるための想定の管理

コードの再利用性を高めるためには、想定の適切な管理が不可欠です。
本記事では、想定がコードの再利用性に与える影響について解説します。

想定がコードの再利用性に与える影響

コードに想定を組み込むことで、一時的にはコードがシンプルになったり、パフォーマンスが向上したりすることがあります。
しかし、想定はコードを脆弱にし、再利用性を低下させる可能性があります。

以下の例を見てみましょう。

def calculate_shipping_cost(order_amount):
    # 送料は注文金額が5,000円以上の場合は無料
    if order_amount >= 5000:
        return 0
    else:
        return 500

この calculate_shipping_cost 関数は、注文金額が5,000円以上の場合、送料が無料になると想定しています。
しかし、この想定は、関数の再利用性を制限します。

将来、送料無料の条件が変更になった場合、この関数を使用しているすべてのコードを修正する必要があります。

解決策1: 想定を避ける

想定を避けることで、コードの再利用性を高めることができます。
以下のように、送料無料の条件をパラメータ化することで、想定を取り除くことができます。

def calculate_shipping_cost(order_amount, free_shipping_threshold):
    if order_amount >= free_shipping_threshold:
        return 0
    else:
        return 500

これにより、calculate_shipping_cost 関数は、様々な状況で再利用できるようになります。
送料無料の条件が変更になっても、関数自体を修正する必要はありません。

解決策2: 想定を明示的に強制する

想定が避けられない場合は、想定を明示的に強制することが重要です。
以下の例では、assert 文を使用して、想定を強制しています。

def apply_discount(price, discount_percentage):
    assert 0 <= discount_percentage <= 100, "割引率は0から100の間でなければなりません"
    discounted_price = price * (1 - discount_percentage / 100)
    return int(discounted_price)

この apply_discount 関数は、割引率が0から100の間であると想定しています。
assert 文を使用することで、この想定を明示的に強制しています。

これにより、関数の呼び出し元は、想定を理解し、適切な値を渡すことが求められます。
また、この関数では、割引後の価格を整数に変換しています。

これは、日本円では通常、小数点以下を使用しないためです。
想定を明示的に強制することで、コードの再利用性を高めることができます。

想定が満たされない場合、早期にエラーを発生させることができるため、バグの発見と修正が容易になります。