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

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

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

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

Введение

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

Текстовый редактор может показывать миллион символов, игра - рисовать тысячи деревьев. Если большая часть данных у них одинакова, создавать полный объект для каждого - пустая трата памяти. Flyweight (легковес) выносит общую часть в один разделяемый объект.

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

Flyweight похож на набор штампов для плаката. Вместо того чтобы вырезать новую «A» каждый раз, когда она встречается, вы держите один штамп «A» и ставите его везде, где нужно. Меняется только место, а штамп один на всех.

От набора штампов к коду
Glyph(character)🔠 По штампу на букву
_cache🗃️ Коробка уже сделанных штампов
setdefault(character, ...)🔍 Взять готовый штамп или сделать новый
first is second✅ Обе A используют один штамп: True
Повторяющаяся часть общая, а уникальную передают при использовании.
Одним предложением

Шаблон Flyweight использует один общий объект везде, где совпадают внутренние данные, а меняющиеся данные, например позицию, хранит вне этого объекта.

Главное

  1. Glyph хранит только общие данные: символ.
  2. _cache - словарь на уровне класса, который хранит по глифу на символ.
  3. self._cache.setdefault(character, Glyph(character)) возвращает сохранённый глиф или сохраняет новый.
  4. Оба вызова для "A" возвращают один и тот же объект, поэтому first is second равно True.

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

  • Огромное число похожих объектов: символы в документе, плитки или деревья в игре.
  • Экономия памяти, когда большая часть данных объектов повторяется.
  • Кэширование неизменяемых значений, которыми пользуются многие части программы.

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

  • Мало объектов: кэш добавляет сложности без реальной экономии.
  • Общие объекты, которые вызывающий код изменяет: одно изменение затронет все места, где объект используется.

Пример кода

Запустить код →
main.py
class Glyph:
    # Flyweight: share repeated intrinsic state between many uses.
    def __init__(self, character): self.character = character


class GlyphFactory:
    _cache = {}

    def get(self, character):
        # Reuse immutable intrinsic state.
        return self._cache.setdefault(character, Glyph(character))


factory = GlyphFactory()
first = factory.get("A")
second = factory.get("A")
print(first is second)
print(first.character)
Получить кнопку запуска для этого примера

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

True
A

Разбор кода

GlyphFactory хранит объекты Glyph в словаре, который служит кешем. Метод setdefault() создаёт новый Glyph, только если символа ещё нет в кеше. Поэтому оба вызова factory.get("A") возвращают один и тот же объект, и сравнение first is second даёт True.

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

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

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

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

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

Уникальные данные в общем объекте

Если бы глиф хранил свою позицию, то при совместном использовании позиции бы перепутались.

Ошибка
glyph = factory.get("A")
glyph.x = 10  # changes every A
Исправление
glyph = factory.get("A")
draw(glyph, x=10, y=20)

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

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