Pythonデザインパターン

PythonのCommandパターン

このレッスンでは、Commandパターンを使って、要求を保存したり、順番に並べたり、後で実行したりできるオブジェクトに変えます。

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

はじめに

どんな問題を解決するか

元に戻すボタン、タスクキュー、マクロ、リモコンはどれも、操作を保存し、受け渡し、あとで実行できるものとして扱う必要があります。普通のメソッド呼び出しはすぐに実行されて消えてしまいます。

身近なたとえ

Command パターンはレストランの注文伝票のようなものです。店員が「4番テーブル、スープ」と伝票に書いて厨房に掛けます。料理人はあとで注文を作り、伝票は保管したり、順番を変えたり、取り消したりできます。

注文伝票からコードへ
LightCommand(light, "on")🧾 依頼を伝票に書く
self.light, self.action📌 伝票は誰が何をするかを知っている
command.execute()👨‍🍳 時が来たら依頼を実行する
[...] list of commands📚 伝票は保存、順番待ち、取り消しができる
依頼が、保存してあとで実行できるオブジェクトになります。
ひと言でいうと

Command パターンは、依頼とその受け手と操作を execute メソッドを持つオブジェクトに包むので、保存、順番待ち、記録、取り消しができます。

重要なポイント

  1. LightCommand は受け手(light)と操作の名前("on" か "off")を保存します。
  2. execute() は getattr(self.light, self.action)() でそのメソッドを引いて呼び出します。
  3. ループは、保存した2つのコマンドが何をするかを知らずに実行します。
  4. コマンドはリストに保存しておけば、再実行や取り消しができます。

どんな場面で使う?

  • 元に戻す・やり直しの履歴。
  • あとで、または別のワーカーで実行するタスクのキュー。
  • 設定可能な操作を起こすボタン、メニュー、キーボードショートカット。

使わなくてよいとき

  • 1回だけ実行する直接の呼び出し:クラスで包むと余計な雑音になります。
  • Python では、保存した関数や functools.partial で十分なことがよくあります。

サンプルコード

コードを実行 →
main.py
class Light:
    # Command: package a request as an object for later execution.
    def on(self): return "Light on"
    def off(self): return "Light off"


class LightCommand:
    def __init__(self, light, action):
        self.light, self.action = light, action

    def execute(self):
        # Store a request as data that can be invoked later.
        return getattr(self.light, self.action)()


light = Light()
for command in [LightCommand(light, "on"), LightCommand(light, "off")]:
    print(command.execute())
この例の実行ボタンを作成

実行結果

Light on
Light off

コードの解説

各LightCommandは、Lightオブジェクトと、onやoffといった実行する操作の名前を保存します。execute()メソッドはgetattr()を使って、Lightの対応するメソッドを呼び出します。ループは2つのコマンドを順に実行し、Light on、Light offと表示します。

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

発展問題

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

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

よくある間違い

コマンドを作るときに操作を実行する

要点は、execute() まで呼び出しを遅らせることです。

問題
command = LightCommand(light, light.on())
修正
command = LightCommand(light, "on")

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

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

チャレンジで練習する

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

すべてのチャレンジ