Pythonデザインパターン
PythonのBuilderパターン
このレッスンでは、Builderパターンを使って、複雑なオブジェクトをわかりやすい手順で組み立てます。
はじめに
どんな問題を解決するか
オブジェクトによっては任意の部品がたくさんあります。レポートには、タイトル、グラフ、表、フッター、またはその組み合わせがあるかもしれません。任意の引数が10個あるコンストラクターは読みにくく、呼び間違えやすくなります。ビルダーは分かりやすい手順で1つずつ部品を加えます。
身近なたとえ
ビルダーはカウンターでサンドイッチを注文するようなものです。「パン、次にチーズ、次にトマト」と言うたびにサンドイッチが育ちます。「以上です」と言えば、完成したサンドイッチを受け取れます。
サンドイッチのカウンターからコードへ
ReportBuilder()🍞 空の注文を始める.add_title()🧀 具を1つ加える.add_chart()🍅 さらに加える。順番に意味がある.build()🥪 完成したサンドイッチを渡すひと言でいうと
Builder パターンは、複雑なオブジェクトを別々のメソッドで1ステップずつ組み立て、最後の build 呼び出しで完成品を返します。
重要なポイント
self.partsはこれまでに加えた部品を集めます。add_titleとadd_chartはそれぞれ部品を1つ加えてreturn selfするので、呼び出しをつなげられます。ReportBuilder().add_title().add_chart().build()は指示の一覧のように読めます。build()は集めた部品を完成したレポートの文字列にします。
どんな場面で使う?
- レポート、HTTP リクエスト、SQL クエリ、文書など、任意の部品が多いオブジェクト。
- メソッドチェーンで、段階的な組み立てを読みやすくする。
- 同じ組み立て手順でいろいろな種類を作る。
使わなくてよいとき
- 必須の項目が2つか3つのオブジェクト:普通のコンストラクターやデータクラスのほうが簡単です。
- 初期値付きのキーワード引数ですでに呼び出しが分かりやすい Python コード。
サンプルコード
main.py
class ReportBuilder:
# Builder: assemble a complex value one optional part at a time.
def __init__(self):
self.parts = []
def add_title(self):
self.parts.append("title")
return self
def add_chart(self):
self.parts.append("chart")
return self
def build(self):
# Hide the final assembly behind one operation.
return "Report: " + ", ".join(self.parts)
report = ReportBuilder().add_title().add_chart().build()
print(report)
実行結果
Report: title, chart
コードの解説
add_title()などの各メソッドはレポートに部品を1つ追加し、builderオブジェクト自身を返します(return self)。そのため、呼び出しを1行に続けて書けます。最後にbuild()メソッドが部品をまとめ、完成したレポートReport: title, chartを返します。
値を変更し、PythonをインストールせずにCodeUtilityオンラインPythonコンパイラで実行できます。
発展問題
下のヒントにしたがってコードを書き換えてみましょう。自分で変えて結果を確かめると、コードを読むだけよりずっと深く理解できます。
- パターンの構造を保ったまま、サンプルの対象領域を置き換えてください。
- パターンをより単純な実装と比較し、トレードオフを説明してください。
- 別の実装を追加する前に、各参加要素のテストを書いてください。
よくある間違い
return self を忘れる
return self がないとメソッドは None を返すので、つなげて呼べません。
問題
def add_title(self):
self.parts.append("title")
修正
def add_title(self):
self.parts.append("title")
return self
このレッスンを終えましたか?
学習済みにすると進み具合を記録できます。
進み具合はこのブラウザーに保存されています ログインすると、どのデバイスでも引き継げます。
チャレンジで練習する
このレッスンの内容を使って実際の問題を解きましょう。各チャレンジはブラウザで動き、すぐにテストされ、AI のレビューも受けられます。
すべてのチャレンジ