A: コーディング — StrEnum × frozen dataclass × replace() パターン

概要

問題

ECサイトの注文処理クラス OrderProcessor に設計上・Pythonイディオムの観点から複数の問題があります。改善してください。

制約・前提条件

• Python 3.12 以上を使用すること
• 型ヒント（type hints）を全面的に付与すること
• dataclass または StrEnum を適切に活用すること
• 状態を表す文字列（"pending", "done", "fail"）は定数化すること
• get_summary() は辞書形式で返すように変更すること

悪いコード (Before)

📋 コピー# --- BAD CODE ---

class OrderProcessor:
    def __init__(self):
        self.orders = []
        self.processed = []
        self.failed = []
        self.total = 0

    def add_order(self, id, amount, status, user):
        order = {"id": id, "amount": amount, "status": status, "user": user}
        self.orders.append(order)

    def process(self):
        for order in self.orders:
            if order["status"] == "pending":
                if order["amount"] > 0:
                    order["status"] = "done"
                    self.total = self.total + order["amount"]
                    self.processed.append(order)
                else:
                    order["status"] = "fail"
                    self.failed.append(order)

    def get_summary(self):
        return "processed: " + str(len(self.processed)) + \
               ", failed: " + str(len(self.failed)) + \
               ", total: " + str(self.total)

ヒント（段階的開示）

from enum import StrEnum
from dataclasses import dataclass, field, replace

class OrderStatus(StrEnum):
    PENDING = "pending"
    DONE = "done"
    FAILED = "failed"

@dataclass(frozen=True)
class Order:
    id: str
    amount: float
    status: OrderStatus
    user: str

@dataclass
class OrderProcessor:
    _orders: list[Order] = field(default_factory=list)
    _processed: list[Order] = field(default_factory=list)
    _failed: list[Order] = field(default_factory=list)
    _total: float = 0.0

    def add_order(self, order: Order) -> None: ...
    def process(self) -> None: ...
    def get_summary(self) -> dict[str, int | float]: ...

問題点分析

設計構造図 — Before / After クラス設計

模範解答

📋 コピーfrom __future__ import annotations
from dataclasses import dataclass, field, replace
from enum import StrEnum


class OrderStatus(StrEnum):
    """注文ステータス。文字列との互換性を保ちながら型安全に管理する。"""
    PENDING = "pending"
    DONE = "done"
    FAILED = "failed"


@dataclass(frozen=True)
class Order:
    """注文を表すイミュータブルなデータクラス。

    frozen=True により、生成後に状態を変更できない。
    ステータス変更は replace() で新しいインスタンスを生成する。
    """
    id: str
    amount: float
    status: OrderStatus
    user: str


@dataclass
class OrderProcessor:
    """注文処理エンジン。注文の受付・処理・集計を担う。"""
    _orders: list[Order] = field(default_factory=list)
    _processed: list[Order] = field(default_factory=list)
    _failed: list[Order] = field(default_factory=list)
    _total: float = 0.0

    def add_order(self, order: Order) -> None:
        """注文を処理キューに追加する。"""
        self._orders.append(order)

    def process(self) -> None:
        """PENDING 状態の注文を処理し、結果に応じて分類する。"""
        for order in self._orders:
            if order.status != OrderStatus.PENDING:
                continue

            if order.amount > 0:
                done_order = replace(order, status=OrderStatus.DONE)
                self._total += done_order.amount
                self._processed.append(done_order)
            else:
                failed_order = replace(order, status=OrderStatus.FAILED)
                self._failed.append(failed_order)

    def get_summary(self) -> dict[str, int | float]:
        """処理結果のサマリーを辞書形式で返す。"""
        return {
            "processed": len(self._processed),
            "failed": len(self._failed),
            "total": self._total,
        }


# --- 実行例 ---
if __name__ == "__main__":
    processor = OrderProcessor()
    processor.add_order(Order(id="ord-001", amount=3000.0, status=OrderStatus.PENDING, user="alice"))
    processor.add_order(Order(id="ord-002", amount=0.0,    status=OrderStatus.PENDING, user="bob"))
    processor.add_order(Order(id="ord-003", amount=1500.0, status=OrderStatus.PENDING, user="carol"))

    processor.process()
    print(processor.get_summary())
    # → {'processed': 2, 'failed': 1, 'total': 4500.0}

ポイント解説

Before vs After 比較

def process(self):
    for order in self.orders:
        if order["status"] == "pending":
            if order["amount"] > 0:
                order["status"] = "done"  # 直接変更
                self.total = self.total + order["amount"]
                self.processed.append(order)

def process(self) -> None:
    for order in self._orders:
        if order.status != OrderStatus.PENDING:
            continue
        if order.amount > 0:
            done_order = replace(order, status=OrderStatus.DONE)
            self._total += done_order.amount
            self._processed.append(done_order)

実務への応用

frozen=True + replace() パターンは、BigQuery に書き込む前の「データ変換ステップ」でよく使われる。特に Pydantic v2 のモデルでも model_copy(update={...}) として同じ概念が登場するので、このパターンを習得しておくと応用範囲が広い。

次のステップ

• 参考: dataclasses モジュール公式ドキュメント
• 参考: PEP 681 (dataclass_transform)
• 参考: 「良いコード・悪いコードで学ぶ設計入門」第3章（クラス設計・責務の分離）

今日のまとめ

自己評価

自分の回答

気づき・メモ