Паттерны проектирования Python

Паттерн проектирования Composite в Python

В этом уроке вы с помощью паттерна Composite будете одинаково работать с отдельным объектом и с группой объектов.

  • Продвинутый
  • Чтение: 2 мин
  • Примеров для запуска: 1

Введение

Какую задачу это решает

В папке лежат файлы и другие папки, в меню - пункты и подменю, в выражении - числа и выражения поменьше. Если коду всё время приходится проверять, один это элемент или группа, он становится запутанным. Composite (компоновщик) позволяет и элементу, и группе отвечать на один и тот же вызов.

Пример из жизни

Шаблон Composite похож на вопрос об общем весе посылки. Отдельный предмет знает свой вес. Коробка спрашивает каждый предмет внутри, включая коробки поменьше, и складывает ответы. Внешней коробке вы задаёте тот же вопрос, что и отдельному предмету.

От коробок в коробках к коду
Number(1)📦 Отдельный предмет: знает свой вес
Sum(...)🗃️ Коробка с предметами и коробками поменьше
sum(child.total() for child in self.children)➕ Коробка спрашивает всё своё содержимое и складывает
expression.total()⚖️ Один вопрос для всей посылки: 6
Листья и группы отвечают на один и тот же вызов.
Одним предложением

Шаблон Composite даёт отдельным объектам и группам объектов один и тот же интерфейс. Поэтому целое дерево таких объектов можно использовать как один объект.

Главное

  1. Number.total() возвращает своё значение: это лист (leaf), узел без потомков.
  2. Sum.total() вызывает total() у каждого потомка и складывает результаты.
  3. Потомком Sum может быть другой Sum, и это делает структуру деревом.
  4. expression.total() возвращает 6, и вызывающему коду не нужно проверять, какого вида каждая часть.

Когда это нужно?

  • Древовидные структуры: папки и файлы, меню и подменю, организационные схемы.
  • Выражения и документы из вложенных частей.
  • Применение одной операции ко всей иерархии.

Когда это не нужно

  • Плоские коллекции без вложенности: хватит простого списка.
  • Листьям и группам нужны очень разные операции: если навязать им общий интерфейс, появятся неуклюжие методы.

Пример кода

Запустить код →
main.py
class Number:
    # Composite: leaves and containers expose the same operation.
    def __init__(self, value): self.value = value
    def total(self): return self.value


class Sum:
    def __init__(self, *children): self.children = children

    def total(self):
        # Treat leaves and nested groups uniformly.
        return sum(child.total() for child in self.children)


expression = Sum(Number(1), Sum(Number(2), Number(3)))
print(expression.total())
Получить кнопку запуска для этого примера

Результат выполнения

6

Разбор кода

У Number и у Sum есть метод total(). Number возвращает своё значение, а Sum вызывает total() у каждого потомка и складывает результаты. Поскольку Sum может содержать другой Sum, выражение Sum(Number(1), Sum(Number(2), Number(3))) вычисляется рекурсивно и даёт 6.

Измените значения и запустите программу в онлайн-компиляторе Python CodeUtility без локальной установки Python.

Упражнения для практики

Попробуйте изменить код по подсказкам ниже. Если менять код и смотреть на результат, урок запомнится гораздо лучше, чем при простом чтении.

  1. Замените предметную область примера, сохранив структуру паттерна.
  2. Сравните паттерн с более простой реализацией и объясните компромиссы.
  3. Напишите тесты для каждого участника перед добавлением новой реализации.
Запустить в компиляторе Python →

Частые ошибки

Проверка типов вместо общего метода

Проверки isinstance ломаются, когда добавляется новый вид узла.

Ошибка
if isinstance(child, Number):
    total += child.value
Исправление
total += child.total()

Закончили этот урок?

Отметьте его как изученный, чтобы следить за прогрессом.

Попрактикуйтесь на задаче

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

Все задачи