Pythonデザインパターン
PythonのDecoratorパターン
このレッスンでは、Decoratorパターンを使って、クラスを変更せずにオブジェクトへ機能を追加します。
はじめに
どんな問題を解決するか
ログ、書式設定、キャッシュなどの追加の振る舞いをオブジェクトに加えたいけれど、そのクラスは変えたくなく、追加機能の組み合わせごとに子クラスも作りたくない、という場面があります。
身近なたとえ
Decorator パターンはプレゼントを包むようなものです。プレゼント自体は変わらず、包装の層ごとに何かが加わります。紙、次にリボン、次にカード。層はどの順番で加えてもよく、結果は同じように渡せるプレゼントのままです。
ギフトラッピングからコードへ
Message()🎁 元のプレゼントUppercase(...)🧻 見た目を変える層Logger(...)🎀 その上にもう1層.render()🤲 同じように渡す:LOG: HELLOひと言でいうと
Decorator パターンは、オブジェクトを同じインターフェースを持つ別のオブジェクトで包み、包んだオブジェクトを呼び出す前後に振る舞いを加えます。
重要なポイント
Message.render()は"hello"を返します。Uppercaseは包んだオブジェクトを持ち、その結果を大文字にして返します。Loggerは包んだオブジェクトの結果の前に"LOG: "を加えます。Logger(Uppercase(Message())).render()は両方の包みを重ね、"LOG: HELLO"になります。
どんな場面で使う?
- 既存のオブジェクトの周りに、ログ、キャッシュ、検証、書式設定を加える。
- 組み合わせごとの子クラスなしに任意の追加機能を組み合わせる。
- 同じ考え方を関数に適用する Python の
@decorator構文を理解する。
使わなくてよいとき
- 決まった追加の振る舞いが1つだけ必要な場合:クラスを変えるかメソッドを加えます。
- 互いの順番に依存する多くの層:重ねたものが分かりにくくなります。
サンプルコード
main.py
class Message:
# Decorator: wrap an object to add behavior dynamically.
def render(self): return "hello"
class Uppercase:
def __init__(self, wrapped): self.wrapped = wrapped
def render(self): return self.wrapped.render().upper()
class Logger:
def __init__(self, wrapped): self.wrapped = wrapped
def render(self):
# Add behavior while preserving the render interface.
return "LOG: " + self.wrapped.render()
print(Logger(Uppercase(Message())).render())
実行結果
LOG: HELLO
コードの解説
UppercaseはMessageオブジェクトを包んで結果を大文字にし、続いてLoggerがUppercaseを包んで接頭辞LOG:を付けます。3つのクラスはどれもrender()メソッドを持つので、どんな順番でも包み合えます。最終的な結果はLOG: HELLOです。
値を変更し、PythonをインストールせずにCodeUtilityオンラインPythonコンパイラで実行できます。
発展問題
下のヒントにしたがってコードを書き換えてみましょう。自分で変えて結果を確かめると、コードを読むだけよりずっと深く理解できます。
- パターンの構造を保ったまま、サンプルの対象領域を置き換えてください。
- パターンをより単純な実装と比較し、トレードオフを説明してください。
- 別の実装を追加する前に、各参加要素のテストを書いてください。
よくある間違い
共通のインターフェースを壊す
メソッド名の違う包みは、さらに包むことも元の代わりに使うこともできません。
問題
class Uppercase:
def show(self): ...
修正
class Uppercase:
def render(self): ...
このレッスンを終えましたか?
学習済みにすると進み具合を記録できます。
進み具合はこのブラウザーに保存されています ログインすると、どのデバイスでも引き継げます。
チャレンジで練習する
このレッスンの内容を使って実際の問題を解きましょう。各チャレンジはブラウザで動き、すぐにテストされ、AI のレビューも受けられます。
すべてのチャレンジ