Pythonデザインパターン

PythonのCompositeパターン

このレッスンでは、Compositeパターンを使って、単独のオブジェクトとオブジェクトのグループを同じように扱います。

  • 上級
  • 約2分で読めます
  • 実行できるサンプル 1 件

はじめに

どんな問題を解決するか

フォルダーの中にはファイルと別のフォルダーが入り、メニューの中には項目とサブメニューが入り、式の中には数とより小さな式が入ります。これは単体の要素か、それともグループかと毎回調べるコードは、ごちゃごちゃになります。Composite なら、どちらも同じ呼び出しで扱えます。

身近なたとえ

Composite パターンは、荷物全体の重さを尋ねるようなものです。品物は1つ1つ、自分の重さを知っています。箱は、中に入っているもの(小さな箱も含む)すべてに重さを尋ね、その答えを合計します。いちばん外の箱にも、品物1つに尋ねるときと同じ質問をするだけです。

箱の中の箱からコードへ
Number(1)📦 1つの品物:自分の重さを知っている
Sum(...)🗃️ 品物と小さな箱が入った箱
sum(child.total() for child in self.children)➕ 箱は中身それぞれに尋ねて足す
expression.total()⚖️ 荷物全体への質問は1つ:6
葉もグループも同じ呼び出しに答えます。
ひと言でいうと

Composite パターンは、単独のオブジェクトとオブジェクトのグループを同じインターフェースで扱うパターンです。これで、木構造全体を1つのオブジェクトのように使えます。

重要なポイント

  1. Number.total() は自分の値を返します。木構造の葉(末端)にあたります。
  2. Sum.total() はすべての子の total() を呼んで結果を足します。
  3. Sum の子は別の Sum でもよいので、全体は木構造になります。
  4. expression.total() は、呼び出し側が各部分の種類を調べなくても6を返します。

どんな場面で使う?

  • フォルダーとファイル、メニューとサブメニュー、組織図などの木構造。
  • 入れ子の部品からなる式や文書。
  • 階層全体に1つの操作を適用する。

使わなくてよいとき

  • 入れ子のない平らなコレクション:単純なリストで十分です。
  • 葉とグループでまったく違う操作が必要な場合:1つのインターフェースを押しつけると不自然なメソッドが増えます。

サンプルコード

コードを実行 →
main.py
class Number:
    # Composite: leaves and containers expose the same operation.
    def __init__(self, value): self.value = value
    def total(self): return self.value


class Sum:
    def __init__(self, *children): self.children = children

    def total(self):
        # Treat leaves and nested groups uniformly.
        return sum(child.total() for child in self.children)


expression = Sum(Number(1), Sum(Number(2), Number(3)))
print(expression.total())
この例の実行ボタンを作成

実行結果

6

コードの解説

NumberとSumはどちらもtotal()メソッドを持っています。Numberは自分の値を返し、Sumは各子要素のtotal()を呼んで合計します。Sumの中に別のSumを入れられるので、式Sum(Number(1), Sum(Number(2), Number(3)))は再帰的に計算され、結果は6になります。

値を変更し、PythonをインストールせずにCodeUtilityオンラインPythonコンパイラで実行できます。

発展問題

下のヒントにしたがってコードを書き換えてみましょう。自分で変えて結果を確かめると、コードを読むだけよりずっと深く理解できます。

  1. パターンの構造を保ったまま、サンプルの対象領域を置き換えてください。
  2. パターンをより単純な実装と比較し、トレードオフを説明してください。
  3. 別の実装を追加する前に、各参加要素のテストを書いてください。
Pythonコンパイラで実行 →

よくある間違い

共通のメソッドを使わず型を調べる

isinstance で型を調べるコードは、新しい種類のノードが加わると動かなくなります。

問題
if isinstance(child, Number):
    total += child.value
修正
total += child.total()

このレッスンを終えましたか?

学習済みにすると進み具合を記録できます。

チャレンジで練習する

このレッスンの内容を使って実際の問題を解きましょう。各チャレンジはブラウザで動き、すぐにテストされ、AI のレビューも受けられます。

すべてのチャレンジ