コーディング設計 弱点補強 — Money値オブジェクト × Decimal

概要

問題

ECサイトの販促システムで、クーポン割引と消費税の計算処理を担当しています。以下の「悪いコード」を読み、問題点を指摘した上で改善してください。

制約・前提条件

• Python 3.12 を使用
• 金額は日本円（整数、または小数第2位まで）
• 割引率は 0.0〜1.0 の範囲（例: 20%オフ → 0.2）
• 消費税率は 0.1（10%）固定で問題なし

悪いコード (Before)

📋 コピーdef apply_discount(price, discount_rate):
    if discount_rate > 1:
        discount_rate = discount_rate / 100  # ← 暗黙変換（問題1）
    return price * (1 - discount_rate)

def calculate_tax(price, tax_rate=0.1):     # ← float（問題2）
    return price * (1 + tax_rate)

# 呼び出し側
price = 1980
discounted = apply_discount(price, 20)   # 20%オフのつもり
total = calculate_tax(discounted)
print(f"合計: {total}円")  # 合計: 1713.6円 ← 端数が出る（問題3）

# また「金額」という概念が裸の数値（問題4）
# バリデーション・振る舞いが散逸している

ヒント（段階的開示）

@dataclass(frozen=True, slots=True)
class Money:
    amount: Decimal
    currency: str = "JPY"

    def __post_init__(self) -> None:
        # バリデーション: 負の金額を拒否
        ...

    def apply_discount(self, rate: Decimal) -> "Money":
        # rate が 0〜1 の範囲外ならエラー
        ...

    def apply_tax(self, rate: Decimal = Decimal("0.1")) -> "Money":
        # 小数点以下切り捨てで返す
        ...

問題点分析

Money 設計図 — 値オブジェクトパターン

模範解答

def apply_discount(price, discount_rate):
    if discount_rate > 1:
        discount_rate = discount_rate / 100
    return price * (1 - discount_rate)

def calculate_tax(price, tax_rate=0.1):
    return price * (1 + tax_rate)

# 呼び出し
discounted = apply_discount(1980, 20)
total = calculate_tax(discounted)
# 合計: 1713.6円 ← 端数

price = Money(Decimal("1980"))
discounted = price.apply_discount(Decimal("0.20"))
total = discounted.apply_tax()
# 元値:   1,980JPY
# 割引後: 1,584JPY
# 税込:   1,742JPY ← 正確

改善後コード（全文）

📋 コピーfrom dataclasses import dataclass
from decimal import Decimal, ROUND_DOWN


# 名前付き定数
DEFAULT_TAX_RATE = Decimal("0.10")
ZERO = Decimal("0")
ONE = Decimal("1")


@dataclass(frozen=True, slots=True)
class Money:
    """金額を表す値オブジェクト。不変・バリデーション済み。

    Args:
        amount: 金額（Decimal）
        currency: 通貨コード（デフォルト: "JPY"）

    Raises:
        ValueError: 金額が負の場合
        TypeError: amount が Decimal でない場合
    """

    amount: Decimal
    currency: str = "JPY"

    def __post_init__(self) -> None:
        if not isinstance(self.amount, Decimal):
            raise TypeError(f"amount は Decimal である必要があります: {type(self.amount)}")
        if self.amount < ZERO:
            raise ValueError(f"金額は0以上でなければなりません: {self.amount}")

    def apply_discount(self, rate: Decimal) -> "Money":
        """割引を適用した新しい Money を返す。

        Args:
            rate: 割引率（0.0〜1.0。例: 20%オフ → Decimal("0.2")）

        Raises:
            ValueError: rate が 0〜1 の範囲外の場合
        """
        if not (ZERO <= rate <= ONE):
            raise ValueError(f"割引率は 0〜1 の範囲でなければなりません: {rate}")
        new_amount = (self.amount * (ONE - rate)).quantize(ONE, rounding=ROUND_DOWN)
        return Money(new_amount, self.currency)

    def apply_tax(self, rate: Decimal = DEFAULT_TAX_RATE) -> "Money":
        """消費税を加算した新しい Money を返す（小数点以下切り捨て）。"""
        new_amount = (self.amount * (ONE + rate)).quantize(ONE, rounding=ROUND_DOWN)
        return Money(new_amount, self.currency)

    def __add__(self, other: "Money") -> "Money":
        if self.currency != other.currency:
            raise ValueError(f"通貨単位が異なる金額は加算できません: {self.currency} vs {other.currency}")
        return Money(self.amount + other.amount, self.currency)

    def __str__(self) -> str:
        return f"{self.amount:,}{self.currency}"


# --- 実行例 ---
if __name__ == "__main__":
    price = Money(Decimal("1980"))
    discounted = price.apply_discount(Decimal("0.20"))  # 20%オフ
    total = discounted.apply_tax()
    print(f"元値:   {price}")       # 元値:   1,980JPY
    print(f"割引後: {discounted}")  # 割引後: 1,584JPY
    print(f"税込:   {total}")       # 税込:   1,742JPY（1584 * 1.1 = 1742.4 → 切り捨て）

ポイント解説

悪いコードの問題点 まとめ

実務への応用

• クーポン割引額の計算ロジックがサービス層に散在せず Money クラスに集約される
• BigQuery へ出力する金額カラムも Decimal → NUMERIC 型でそのままマッピング可能
• Pydantic v2 との相性も良く condecimal や Annotated[Decimal, Gt(0)] で API バリデーションも統一できる

次のステップ

• 参考: 「良いコード・悪いコードで学ぶ設計入門」第7章「コレクションオブジェクト」・第3章「クラスで表現する」

今日のまとめ

自己評価

自分の回答

気づき・メモ