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

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

В этом уроке вы с помощью паттерна Decorator добавите объекту новые возможности, не меняя его класс.

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

Введение

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

Нужно добавить объекту дополнительное поведение, например логирование, форматирование или кэширование, не меняя его класс и не создавая подкласс на каждое сочетание дополнений.

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

Шаблон Decorator похож на упаковку подарка. Подарок остаётся тем же; каждый слой упаковки что-то добавляет: бумагу, потом ленту, потом открытку. Слои можно добавлять в любом порядке, и результат всё равно остаётся подарком, который вручают так же.

От упаковки подарка к коду
Message()🎁 Исходный подарок
Uppercase(...)🧻 Слой, который меняет его вид
Logger(...)🎀 Ещё один слой сверху
.render()🤲 Вручается так же: LOG: HELLO
Каждая обёртка предлагает тот же метод и добавляет своё поведение.
Одним предложением

Шаблон Decorator оборачивает объект другим объектом с тем же интерфейсом, который вызывает обёрнутый объект и добавляет поведение до или после него.

Главное

  1. Message.render() возвращает "hello".
  2. Uppercase хранит обёрнутый объект и возвращает его результат заглавными буквами.
  3. Logger добавляет "LOG: " перед результатом обёрнутого объекта.
  4. Logger(Uppercase(Message())).render() накладывает обе обёртки и даёт "LOG: HELLO".

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

  • Добавление логирования, кэширования, проверки или форматирования вокруг существующих объектов.
  • Сочетание необязательных дополнений без подкласса на каждое сочетание.
  • Понимание синтаксиса @decorator в Python, который применяет ту же идею к функциям.

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

  • Нужно только одно фиксированное дополнение: измените класс или добавьте метод.
  • Много слоёв, зависящих от порядка друг друга: такую стопку трудно понять.

Пример кода

Запустить код →
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:. У всех трёх классов есть метод render(), поэтому они могут оборачивать друг друга в любом порядке. Итоговый результат LOG: HELLO.

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

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

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

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

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

Нарушение общего интерфейса

Обёртку с другим именем метода нельзя снова обернуть или использовать вместо оригинала.

Ошибка
class Uppercase:
    def show(self): ...
Исправление
class Uppercase:
    def render(self): ...

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

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

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

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

Все задачи