Python デザインパターン サンプルコード Template Method
結城 浩「Java言語で学ぶデザインパターン入門」をPython化
Python3(3.11)で動くソースコード（.pyファイル .ipynbファイル）あります
「anaconda3」on .py「PyCharm」.ipynb「Jupyter Notebook」

◆◆Composite パターンの使われる場面◆◆

Composite とは合成物や複合体のようなニュアンスがある。Composite パターンはツリー構造の一種であるが，ノードが2種類あるので Composite パターンと言われる。

Java サンプルはディレクトリエントリを対象としている。Windows で言えば，フォルダ（ディレクトリ）とファイルである。一般的なツリー構造と違う特徴は，フォルダは中身がなくてもフォルダであり将来に中身が入る可能性があり，ファイルは中身を入れることができない。

Java サンプルの出力のツリーを Windows Explorer 風に表現したもの（カッコ内はサイズ）

root
  = bin
      = vi（10000）
      = latex（20000）
  = tmp
  = usr
      = yuki
          = diary.html（100）
          = Composite.java（200）
      = hanako
          = memo.tex（300）
      = tomura
          = game.doc（400）
          = junk.mail（500）

このような特徴のあるツリー構造を従来からあるグラフ理論のアルゴリズムではなくオブジェクト指向の考えで実装すると，GoF が言うようにフォルダ（ディレクトリ）とファイルを区別することなく扱うことができるようになる。結城氏はこのことを容器と中身の同一視と表現した。

GoFのC++サンプルは製品と部品（と中間にサブアッシー）を部分―全体階層（子が次に親になる階層のこと）に適用している。

ツリー構造の従来のアルゴリズムは，ノードの表現をリストや dict 辞書やその他であってもネスト（入れ子）により再帰定義を表現するのが普通である。Composite パターンでは，メソッドの中で自分自身を呼ぶ再帰呼び出しを使い，さらにインスタンスを巧みに使い分けることによって容器と中身の扱いを同じにしているのである。

この発想は個人が独力で思いつくことが難しいと思われ，この再帰呼び出しを応用するだけでも十分に役に立つと考えられる。

（2023-11-18）Python3.11で動作確認済み

◆◆Composite パターンとは◆◆

GoFによれば，Composite パターンの目的は， 「部分―全体階層を表現するために，オブジェクトを木構造に組み立てる。Composite パターンにより，クライアントは，個々のオブジェクトとオブジェクトを合成したものを一様に扱うことができるようになる。」

GoFによれば，次のような場合に，Composite パターンを使用する。
・オブジェクトの部分―全体階層を表現したい場合。
・クライアントが，オブジェクトを合成したものと個々のオブジェクトの違いを無視できるようにしたい場合。このパターンを用いることで，クライアントは，composite 構造内のすべてのオブジェクトを一様に扱うことができるようになる。

GoFによれば，Composite パターンの関連するパターンは次のようなものである。
Chain Of Responsibility パターン：親子関係にあるオブジェクト間のリンクは，Chain Of Responsibility パターンでしばしば使われる。
Decorator パターン：しばしば Composite パターンとともに使われる。decorator と composite を同時に使う場合，通常，これらは共通の親クラスを持つ。そのため decorator は，Add，Remove，GetChild のようなオペレーションで Component クラスのインタフェースをサポートしなければならなくなる。
Flyweight パターン：このパターンにより，component を共有できるようになる。しかし，共有されるオブジェクトは親オブジェクトを参照できなくなる。
Iterator パターン：composite を走査するために使われる。
Visitor パターン：Composite クラスや Leaf クラスに分散しているオペレーションや振る舞いを局所化する。

◆◆Composite パターンのサンプルのクラス構成◆◆

ソースコードは巻末にあり，ソースファイルはこのWebの左上隅にありダウンロードできます。

                                 Entry
                      (getName, getSize, printList)

                      ↑                 ↑
                      File             Directory
 (getName, getSize, printList)   (getName, getSize, printList, add)

class Entry は，抽象メソッドでありテンプレートです。
class File は，ファイルを取り扱います
class Directory は，フォルダ（ディレクトリ）を取り扱います。また，ファイルとフォルダ（ディレクトリ）をツリーに登録することができます。

◆◆Composite パターンの実装◆◆

この実装の第1の特徴は if 文がないということです（Java サンプルも同じ）。最後にある if は，自分がトップレベルにあるか判断するものです。オブジェクト指向を徹底すると if 文を減らせます。そうすると，アルゴリズムが簡単になりミスもなくなります。Composite パターンのオブジェクトの使い方は独力で思いつくようなものではないです。そのあたりを詳細に説明します。

class Entry は，抽象メソッドであり詳細は省略します。
def __str__はインスタンスを print すると呼ばれます。これがないままインスタンスを print するとメモリアドレスが表示されるだけです。デザインパターンではインスタンスを自在に使いこなすことが多いのでたいへん便利な特殊関数です。

メソッド getNameとメソッド getSizeはメソッド printList から呼ばれます。これらのすべてのメソッドはクライアント；メインルーチンのたった1行から呼ばれます。そのようなことができるのはツリー構造がオブジェクト指向の考えで出来上がっているからです。

Java と違って Python にはオーバロード（シグニチャが違う同名メソッド）がないのですが printList ではオーバロードもどきようなことをしています。

class Directory のメソッド add はメインルーチンだけから呼ばれます。ファイルとフォルダ（ディレクトリ）をツリーに登録することができます。

ツリーの各ノード（ファイルとフォルダ（ディレクトリ））の登録はすべてクライアント；メインルーチンから行います。この登録の書式が Composite パターンを特徴づけています。応用するときはこの登録を自動化する必要があるかと考えます。

登録の方法は次のようにします。

    usrdir = Directory("usr")   # "usr"をインスタンス化してインスタンス「usrdir」を得る
    rootdir.add(usrdir)         # 「usrdir」をインスタンス「rootdir」のリストに加える

    yuki = Directory("yuki")    # "yuki"をインスタンス化してインスタンス「yuki」を得る
    usrdir.add(yuki)            # 「yuki」をインスタンス「usrdir」のリストに加える

    yuki.add(File("diary.html", 100))  # "diary.html"をインスタンス化して
                                       # インスタンス「yuki」のリストに加える

このようにしてすべてのノード（ファイルとフォルダ（ディレクトリ））はインスタンス化されます。そのうち各ディレクトリの各インスタンスはそれぞれリストを持っています。各ディレクトリの中身（子ノード）はそのリストに入ることになります。上の例はリストが3つあり最後のファイルも含めて4階層になっていることが判ると思います。

ツリー構造のアルゴリズムをまったく意識しなくても上のソースコードのように決まった書式で登録ができます。登録されるノードのインスタンスはメソッド add の引数となり，メソッド add の前に親ノードのインスタンスを付けるという簡単な書式です。

これで出来上がったリストは各インスタンスに所属しているだけであり，ネスト（入れ子）構造になっているわけではありません。リストの親子関係はそれの所属するインスタンスに記録されているわけです。

ファイルとフォルダ（ディレクトリ）の棲み分けはインスタンス化するときだけクラスを選ぶだけです。あとはすべて区別していません。そのことは同名メソッドで抽象メソッドをオーバーライドすることで実現しています。

メソッド getName は説明の必要はないと考えます。

class File のメソッド getSize も説明の必要はないと考えます。

class Directory のメソッド getSize では Iterator パターンの手法が使われています。属性もツリー構造になっているので再帰呼び出しが使われていますが，自分自身を呼び出すとき選ばれたインスタンス付きとなっています。このことにより，親子関係の再帰定義を意識することなく，また，ファイルとフォルダ（ディレクトリ）を意識することなく，単純な呼び出しで複雑なアルゴリズムを実現しています（Python の手法を使うとこれが1行で書けるそうです）。

【class Directory のメソッド getSize】

class Directory のメソッド printList も上と同じことが言えます。繰り返しますが，親子関係の再帰定義を意識することなく，また，ファイルとフォルダ（ディレクトリ）を意識することなく，単純な呼び出しで複雑なアルゴリズムを実現しています。

【class Directory のメソッド printList】

さらに各ノードの属性も同じように扱うことができます。例えば，属性の size を個々に表示するのは簡単にできることは判ると思いますが，その合計を表示することはそう簡単ではありません。オブジェクト指向の考えがそれを簡単にしてしまうのです。

◆◆ソースコード◆◆

このWebページの左上隅からダウンロードできます。

ソースファイルは1つです。
・Composite；Composite パターンのPythonサンプル

【Composite】

以上