Pythonデザインパターン

PythonのVisitorパターン

このレッスンでは、Visitorパターンを使って、クラスを変更せずにオブジェクトのグループへ新しい操作を追加します。

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

はじめに

どんな問題を解決するか

図形や商品のように安定したクラスの集まりがあり、合計価格、税金、JSON への書き出しなど、新しい操作を次々に加えるとします。各操作をすべてのクラスのメソッドとして加えると、1つの機能が多くのファイルに散らばります。

身近なたとえ

Visitor パターンは、税務調査官がいろいろな店を訪ねるようなものです。各店は調査官を中に入れ、自分がどんな店かを伝えるだけです。調査官があらゆる種類の店のルールを持っているので、新しいルールには新しい調査官が要るだけで、すべての店を変える必要はありません。

税務調査官からコードへ
item.accept(visitor)🚪 店が調査官を中に入れる
visitor.visit_book(self)🏷️ どんな店かを伝える
PriceVisitor🧾 ルールを持った調査官
15💰 本1冊と映画1本の合計
操作は要素のクラスではなく、ビジターの中にあります。
ひと言でいうと

Visitor パターンは、要素のクラス群から操作を取り出して別のビジターオブジェクトに移します。各要素は自分の型に合うビジターのメソッドを呼びます。

重要なポイント

  1. Book.accept は visitor.visit_book(self) を、Movie.accept は visitor.visit_movie(self) を呼びます。
  2. PriceVisitor は両方の種類の価格ルールを持ちます。
  3. sum(item.accept(visitor) for item in [Book(), Movie()]) は10と5を足します。
  4. 税金のような新しい操作は、Book や Movie を変えずに新しいビジタークラスになります。

どんな場面で使う?

  • 価格計算、書き出し、描画など、安定した型の集まりに対する多くの操作。
  • コンパイラーの構文木などの構造をたどる。
  • 1つの機能のコードを1か所にまとめる。

使わなくてよいとき

  • 新しい要素の型が頻繁に加わる場合:そのたびにすべてのビジターを更新する必要があります。
  • 型ごとの関数の辞書や functools.singledispatch のほうが簡単な Python コード。

サンプルコード

コードを実行 →
main.py
class Book:
    # Visitor: move new operations outside stable element classes.
    def accept(self, visitor): return visitor.visit_book(self)


class Movie:
    def accept(self, visitor): return visitor.visit_movie(self)


class PriceVisitor:
    def visit_book(self, book): return 10
    def visit_movie(self, movie): return 5


# Each element dispatches to the matching visitor method.
visitor = PriceVisitor()
print(sum(item.accept(visitor) for item in [Book(), Movie()]))
この例の実行ボタンを作成

実行結果

15

コードの解説

各要素はaccept()メソッドを持ち、visitorの対応するメソッドを呼びます。Bookはvisit_book()を、Movieはvisit_movie()を呼びます。PriceVisitorが価格計算のロジックをすべて持っているので、BookとMovieのクラスは価格について何も知る必要がありません。合計は10 + 5 = 15です。

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

発展問題

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

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

よくある間違い

間違ったビジターのメソッドを呼ぶ

要素は自分の型のメソッドを呼ぶ必要があり、そうしないと違うルールが適用されます。

問題
class Movie:
    def accept(self, visitor): return visitor.visit_book(self)
修正
class Movie:
    def accept(self, visitor): return visitor.visit_movie(self)

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

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