Pythonデザインパターン
PythonのTemplate Methodパターン
このレッスンでは、Template Methodパターンを使って、処理の手順を固定しつつ、一部の手順をサブクラスでカスタマイズできるようにします。
はじめに
どんな問題を解決するか
多くの処理は、手順の順番が同じで1つの手順だけが違います。データパイプラインはどれも読み込み、処理、保存をしますが、CSV の処理と JSON の処理は違います。種類ごとに処理全体をコピーすると順番が重複し、間違いのもとになります。
身近なたとえ
Template Method パターンは、1行だけ空欄のあるレシピカードのようなものです。カードは順番を決めています。下ごしらえ、具を作る、盛り付ける。料理人はそれぞれ空欄に自分の具を書くだけで、手順の順番は誰も変えられません。
レシピカードからコードへ
run()📇 決まった手順のレシピカード"read", ..., "save"🔒 決して変わらない手順self.process()✏️ 料理人ごとに埋める空欄CsvPipeline🧑🍳 ある料理人のその手順ひと言でいうと
Template Method パターンは、アルゴリズムの手順を親クラスのメソッドで定め、全体の順番を変えずに特定の手順だけを子クラスがオーバーライドできるようにします。
重要なポイント
DataPipeline.run()は順番を決めます:読み込み、処理、保存。processは@abstractmethodが付いているので、どの子クラスも用意しなければなりません。CsvPipelineはprocessだけをオーバーライドします。CsvPipeline().run()は決まった順番を保ち、CSV の手順を使います。
どんな場面で使う?
- パイプライン、書き出し、ゲームのターンなど、順番が決まっていて一部の手順だけ変わる流れ。
- 決まった時点であなたのコードを呼ぶフレームワーク。
- 似たクラスから重複した制御の流れを取り除く。
使わなくてよいとき
- 変わる手順が1つだけで簡単な場合:子クラスを作る代わりに関数を渡します(Strategy)。
- 種類によって手順の順番そのものが変わる場合。
サンプルコード
main.py
from abc import ABC, abstractmethod
class DataPipeline(ABC):
# Template Method: fix the workflow and customize selected steps.
def run(self):
# Keep the algorithm order stable.
return ["read", self.process(), "save"]
@abstractmethod
def process(self): pass
class CsvPipeline(DataPipeline):
def process(self): return "process CSV"
print(" -> ".join(CsvPipeline().run()))
実行結果
read -> process CSV -> save
コードの解説
DataPipelineのrun()メソッドは、read、process、saveの順番を固定しています。process()の手順には@abstractmethodが付いているので、どのサブクラスも必ず自分で実装しなければなりません。CsvPipelineは独自の処理process CSVを用意し、結果はread -> process CSV -> saveになります。
値を変更し、PythonをインストールせずにCodeUtilityオンラインPythonコンパイラで実行できます。
発展問題
下のヒントにしたがってコードを書き換えてみましょう。自分で変えて結果を確かめると、コードを読むだけよりずっと深く理解できます。
- パターンの構造を保ったまま、サンプルの対象領域を置き換えてください。
- パターンをより単純な実装と比較し、トレードオフを説明してください。
- 別の実装を追加する前に、各参加要素のテストを書いてください。
よくある間違い
子クラスで run をオーバーライドする
run を書き直すと順番が重複し、壊れることもあります。
問題
class CsvPipeline(DataPipeline):
def run(self):
return ["process CSV", "save"] # read was forgotten
修正
class CsvPipeline(DataPipeline):
def process(self):
return "process CSV"
このレッスンを終えましたか?
学習済みにすると進み具合を記録できます。
進み具合はこのブラウザーに保存されています ログインすると、どのデバイスでも引き継げます。