Посетитель на Python

Паттерны проектирования / Поведенческие паттерны

from abc import ABC, abstractmethod

class Element(ABC):
    @abstractmethod
    def accept(self, v):
        pass

# ConcreteElement
class Engine(Element):
    def accept(self, v):
        v.visit_engine(self)

# ConcreteElement
class Wheel(Element):
    def __init__(self, number):
        self.number = number

    def accept(self, v):
        v.visit_wheel(self)

# ConcreteElement
class Car(Element):
    def __init__(self):
        self.items = [
            Engine(),
            Wheel(1), Wheel(2),
            Wheel(3), Wheel(4)]

    def accept(self, v):
        for e in self.items:
            e.accept(v)
        v.visit_car(self)

# Visitor
class CarVisitor(ABC):
    @abstractmethod
    def visit_engine(self, engine):
        pass

    @abstractmethod
    def visit_wheel(self, wheel):
        pass

    @abstractmethod
    def visit_car(self, car):
        pass

# ConcreteVisitor
class TestCarVisitor(CarVisitor):
    def visit_engine(self, engine):
        print("test engine")

    def visit_wheel(self, wheel):
        print("test wheel #" +
              str(wheel.number))

    def visit_car(self, car):
        print("test car")

# ConcreteVisitor
class RepairCarVisitor(CarVisitor):

    def visit_engine(self, engine):
        print("repair engine")

    def visit_wheel(self, wheel):
        print("repair wheel #" +
              str(wheel.number))

    def visit_car(self, car):
        print("repair car")

# Client
car = Car()
v1 = TestCarVisitor()
v2 = RepairCarVisitor()

car.accept(v1)
car.accept(v2)

Представляет операцию, которую надо выполнить над элементами объекта. Позволяет определить новую операцию, не меняя классы элементов, к которым он применяется.

Задача. Документ состоит из абзацев, картинок и таблиц. Программа должна выгружать его, считать в нём слова и проверять орфографию. Если каждую операцию добавлять методом в каждый вид части, классы частей растут с каждой новой операцией. К тому же код одной операции расползается по многим классам.

Идея. Каждая операция становится отдельным объектом - посетителем. У посетителя по методу на каждый вид элемента. У каждого элемента есть один метод, который принимает посетителя и вызывает его метод для своего вида. Так для каждой пары «элемент и операция» выполняется нужный код, без проверок типа. Чтобы добавить новую операцию, пишут нового посетителя, а классы элементов не меняются.

Как читать пример. Элементы бывают нескольких видов. Каждый конкретный посетитель - одна операция, с отдельным методом на каждый вид элемента. Клиентский код отдаёт посетителя элементам, и каждый элемент направляет его в метод для своего вида. В большинстве примеров один элемент содержит остальные и отдаёт посетителя каждой своей части. Затем два посетителя проходят по одним и тем же частям, каждый со своей операцией. В некоторых языках элементы - обычные данные с меткой типа, а посетитель - одна функция с вариантом для каждого вида.

Когда применять. Посетитель нужен, когда набор классов элементов устойчив, а новые операции над ними появляются часто. Если часто добавляются новые виды элементов, он не годится: каждый новый вид требует нового метода в каждом посетителе.

Частая ошибка. Проверять тип элемента условиями внутри одного общего метода посетителя. Тогда новый вид элемента пропускается без всякого предупреждения. У каждого вида должен быть свой метод.